Metadata-Version: 2.1
Name: mtress
Version: 3.0.0a2
Home-page: https://github.com/mtress/mtress
Author: Deutsches Zentrum für Luft- und Raumfahrt e.V. (DLR)
Author-email: patrik.schoenfeldt@dlr.de
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: graphviz
Requires-Dist: oemof.solph<0.6,>=0.5.1
Requires-Dist: oemof.thermal>=0.0.6.dev1
Requires-Dist: pandas>=1.3.4
Requires-Dist: PyYAML>=6.0
Requires-Dist: numpy>=1.21.4
Requires-Dist: setuptools>=59.1.1
Requires-Dist: pvlib

# Model Template for Renewable Energy Supply Systems (MTRESS)

This is a generic model for [oemof.solph](https://github.com/oemof/oemof-solph/)
that provides a variety of possible technology combinations for energy supply systems.
It is tailored for optimising control strategies fulfilling fixed demand time series
for electricity, heat, and domestic hot water using any selected combination
of the implemented supply technologies.

The development of Version 2 was funded by the Federal Ministry for Economic Affairs and Energy (BMWi)
and the Federal Ministry of Education and Research (BMBF) of Germany
in the project ENaQ (project number 03SBE111).
The development of the heat sector formulations in Version 3 was funded by the Federal Ministry of
Education and Research (BMBF) of Germany in the project Wärmewende Nordwest (project number 03SF0624).


## Installation

MTRESS depends on solph, which is automatically instaled using pip
if you `pip install mtress`. However, pip will not install a solver,
to perform the actual optimisation. Please refer to the
[documentation of solph](https://oemof-solph.readthedocs.io/en/v0.4.4/readme.html#installing-a-solver)
to learn how to install a solver.


## Contributing

You are welcome to contribute to MTRESS. We use [Black code style](https://black.readthedocs.io/),
and put our code under [MIT license](LICENSE). When contributing, you need to do the same.
For smaller changes, you can just open a merge request. If you plan something bigger,
please open an issue first, so that we can discuss beforehand and avoid double work.


## Contact

The software development is administrated by [Patrik Schönfeldt](mailto:patrik.schoenfeldt@dlr.de),
for general questions please contact him. Individual authors may leave their contact information
in the [citation.cff](CITATION.cff).
