MTRESS

Facilitates the creation of energy system optimisation models for individual residential and commercial buildings, as well as for neighbourhoods and entire industrial properties.
https://github.com/mtress/mtress

Category: Energy Systems
Sub Category: Renewable Energy Integration

Keywords from Contributors

energy-system modelling-framework

Last synced: about 24 hours ago
JSON representation

Repository metadata

README.md

Model Template for Renewable Energy Supply Systems (MTRESS)

Introduction

The DLR Institute of Networked Energy Systems has developed the MTRESS tool that can be
used to optimise energy supply systems for new and existing projects at any location.
MTRESS facilitates the creation of energy system optimisation models for individual
residential and commercial buildings, as well as for neighbourhoods and entire industrial
properties. It enables users to include a wide range of influencing factors and energy
options in the simulation and minimises the planning effort.

This is a generic model for community-based open source oemof.solph tool.
MTRESS offers a variety of possible technology combinations for energy supply systems.
It includes pre-built technologies that are commonly considered in energy systems, such as:

  • Photovoltaic or wind power (as generic RenewableEnergySource)
  • Grid Connection (Electricity, Heat and Gas)
  • Heat Pumps
  • Heat Exchangers
  • Electrolysers (PEM, Alkaline, AEM)
  • Fuel Cells (PEM, Alkaline, AEM)
  • Compressors
  • Combined Heat and Power (CHP) with various gas types and gas-mixtures (e.g., H2 + Natural Gas) as input fuels
  • Storages (Battery, Heat Storage, Gas Storage (Hydrogen))
  • Resistive Heater and Gas Boiler

It covers different sectors including Electricity, Heat and Gas (e.g., H2, Natural Gas,
Biogas, etc.). It is tailored for optimising control strategies fulfilling fixed
demand time series for electricity, heat, gas (including hydrogen), and domestic hot
water using any selected combination of the implemented supply technologies.

MTRESS requires appropriately prepared initial data on the boundary conditions of the
respective project. A wide range of data sources can be used, including
historical energy consumption data for the project, but also higher-level data
on the location, for example from climate models or the solar cadastre. Moreover, the
forecasted demands and renewable generations could also be used for scheduling optimized
operation for next days.
It could be used for long-term planning and the assumptions about the development of
costs and the CO2 impact of the future energy mix can also be incorporated into the
modelling.

As an open-source model, MTRESS is available to users in a wide range of areas. It can
be utilized for both research and commercial purposes. Researchers, utility owners, and
policymakers can all benefit from this tool for energy system planning and operation.
Applications are not just limited to municipal heating plans, home automation offerings,
hydrogen infrastructure planning, and optimized operation of sector-coupled energy
systems, but extend to any scenario requiring comprehensive energy optimization and
management.

Installation

MTRESS depends on solph, which is automatically installed using pip

pip install mtress

However, pip will not install a solver,
to perform the actual optimisation. Please refer to the
documentation of solph
to learn how to install a solver.

Documentation

The auto-generated documentation can be found on the GitLab pages.
The coverage report can be found on the GitLab pages as well.

Usage and Tutorials

Please refer to the examples folder in this repository to get acquainted with building
and optimizing energy systems in MTRESS. These examples will help you understand the
basics and guide you through the process before you start creating your own energy system.

Please feel free to contact us if you have any questions or need further assistance.
Contact information can be found below.

Acknowledgements

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).
The development of the gas sector formulations in Version 3 was funded by the Federal
Ministry of Education and Research (BMBF) of Germany in the project H2Giga-Systogen100 (project number 03HY115E).

Contributing

You are welcome to contribute to MTRESS. We use
Black code style with 79 characters a line,
and put our code under MIT 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.
Also, please report bugs by opening an issue.

Citation

If you use MTRESS Software for your research, please consider citation as follows using the
Zenodo record, doi:10.5281/zenodo.6395909.

Reference

[1]
Schönfeldt, Patrik and Schlüters, Sunke and Oltmanns, Keno,"MTRESS 3.0--Modell Template for Residential Energy Supply Systems",
arXiv preprint, 2022, arXiv:2211.14080.

Contact

The software development is administrated by Patrik Schönfeldt,
for general questions please contact him. Individual authors may leave their contact information
in the citation.cff.

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it using these metadata."
title: "Model Template for Renewable Energy Supply Systems (MTRESS)"
license: MIT
authors:
  -
    affiliation: "Deutsches Zentrum für Luft- und Raumfart (DLR)"
    family-names: "Schönfeldt"
    given-names: Patrik
    orcid: "https://orcid.org/0000-0002-4311-2753"
  -
    affiliation: "Deutsches Zentrum für Luft- und Raumfart (DLR)"
    family-names: "Schlüters"
    given-names: Sunke
  -
    affiliation: "Deutsches Zentrum für Luft- und Raumfart (DLR)"
    family-names: Upadhaya
    given-names: Ajay
    orcid: "https://orcid.org/0000-0002-4531-0200"
  -
    affiliation: "Deutsches Zentrum für Luft- und Raumfart (DLR)"
    family-names: Oltmanns
    given-names: Keno

GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 1,403
Total Committers: 24
Avg Commits per committer: 58.458
Development Distribution Score (DDS): 0.584

Commits in past year: 381
Committers in past year: 6
Avg Commits per committer in past year: 63.5
Development Distribution Score (DDS) in past year: 0.654

Name Email Commits
Patrik Schönfeldt p****t@d****e 583
Ellermann j****n@d****e 196
“mald_di” “****o@d****” 136
upad_aj a****a@d****e 128
Pedro Lacerda de Magalhães p****s@d****e 126
Sunke Schlüters s****s@d****e 123
lschmeling l****g@k****e 45
Patrik Schönfeldt g****b@p****e 13
Torio H****o@d****e 10
Diana Maldonado D****o@d****e 9
dhun_go O****3 7
Keno Oltmanns k****s@d****e 5
Alexander Hill a****l@o****e 3
Patrik Schönfeldt g****t@p****e 3
Martin Krisch i****o@i****e 2
Tobias Brandt t****1@g****m 2
Turhan E****n@d****e 2
Meike Kühnel m****l@d****e 2
Maldonado Castro, Diana Teresa d****o@d****e 2
Hancock, Cody c****k@d****e 2
Fernando Penaherrera f****a@o****e 1
Maximilian.Hillen@dlr.de m****n@d****e 1
gaik_na n****d@d****e 1
von Rüden l****n@d****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: about 1 month ago

Total issues: 17
Total pull requests: 11
Average time to close issues: 4 months
Average time to close pull requests: 17 days
Total issue authors: 7
Total pull request authors: 2
Average comments per issue: 0.76
Average comments per pull request: 0.36
Merged pull request: 10
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 1
Past year pull request authors: 0
Past year average comments per issue: 1.0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/mtress/mtress

Top Issue Authors

  • p-snft (10)
  • BenHanke (2)
  • ahilloffis (1)
  • jhbruhn (1)
  • aghosh-debug (1)
  • sajonasra (1)
  • flpeters (1)

Top Pull Request Authors

  • p-snft (10)
  • ahilloffis (2)

Top Issue Labels

  • enhancement (5)
  • bug (1)
  • good first issue (1)

Top Pull Request Labels


Package metadata

pypi.org: mtress

  • Homepage: https://github.com/mtress/mtress
  • Documentation: https://mtress.readthedocs.io/
  • Licenses: MIT License
  • Latest release: 2.2.0 (published over 2 years ago)
  • Last Synced: 2026-01-01T04:01:11.000Z (4 days ago)
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 91 Last month
  • Rankings:
    • Dependent packages count: 10.119%
    • Stargazers count: 18.522%
    • Dependent repos count: 21.545%
    • Forks count: 22.645%
    • Average: 23.823%
    • Downloads: 46.285%
  • Maintainers (2)

Dependencies

requirements.txt pypi
  • PyYAML *
  • numpy *
  • oemof.solph >0.4.2,<0.5
  • oemof.thermal >=0.0.5
  • pandas *
  • setuptools *
setup.py pypi
  • oemof.solph *
  • oemof.thermal *
  • pvlib *
  • pyyaml *
.github/workflows/tox_pytests.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v2 composite

Score: 10.812391065976266