{"id":318491,"name":"MTRESS","description":"Facilitates the creation of energy system optimisation models for individual residential and commercial buildings, as well as for neighbourhoods and entire industrial properties.","url":"https://github.com/mtress/mtress","last_synced_at":"2026-04-08T03:30:20.744Z","repository":{"id":41965855,"uuid":"407595633","full_name":"mtress/mtress","owner":"mtress","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-23T09:48:05.000Z","size":12393,"stargazers_count":15,"open_issues_count":7,"forks_count":5,"subscribers_count":2,"default_branch":"dev","last_synced_at":"2026-03-25T16:58:01.615Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mtress.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-17T15:43:00.000Z","updated_at":"2026-01-26T15:46:53.000Z","dependencies_parsed_at":"2023-02-14T07:31:05.810Z","dependency_job_id":null,"html_url":"https://github.com/mtress/mtress","commit_stats":{"total_commits":331,"total_committers":13,"mean_commits":25.46153846153846,"dds":0.540785498489426,"last_synced_commit":"7cfd0514c4b49501d94c1fcef613be0cc405f1d2"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/mtress/mtress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mtress","download_url":"https://codeload.github.com/mtress/mtress/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress/sbom","scorecard":{"id":666777,"data":{"date":"2025-08-11","repo":{"name":"github.com/mtress/mtress","commit":"180b735336b7a1e5d277b14a4ed295bbbb7503a9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.4,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":10,"reason":"28 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/tox_pytests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'dev'","Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tox_pytests.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/mtress/mtress/tox_pytests.yml/dev?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tox_pytests.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/mtress/mtress/tox_pytests.yml/dev?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/tox_pytests.yml:33","Warn: pipCommand not pinned by hash: .github/workflows/tox_pytests.yml:34","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-21T18:19:30.970Z","repository_id":41965855,"created_at":"2025-08-21T18:19:30.970Z","updated_at":"2025-08-21T18:19:30.970Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31421869,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T00:25:07.052Z","status":"online","status_checked_at":"2026-04-05T02:00:05.211Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"owner":null,"packages":[],"commits":{"id":614952,"full_name":"mtress/mtress","default_branch":"dev","total_commits":1460,"total_committers":25,"total_bot_commits":0,"total_bot_committers":0,"mean_commits":58.4,"dds":0.5924657534246576,"past_year_total_commits":271,"past_year_total_committers":7,"past_year_total_bot_commits":0,"past_year_total_bot_committers":0,"past_year_mean_commits":38.714285714285715,"past_year_dds":0.5166051660516605,"last_synced_at":"2026-04-05T02:07:27.647Z","last_synced_commit":"c582a17f436bada9153a26453d9399ac6e859f69","created_at":"2023-03-09T07:37:53.428Z","updated_at":"2026-04-05T02:03:09.681Z","committers":[{"name":"Patrik Schönfeldt","email":"patrik.schoenfeldt@dlr.de","login":"p-snft","count":595},{"name":"Ellermann","email":"julius.ellermann@dlr.de","login":null,"count":236},{"name":"“mald_di”","email":"“diana.maldonado@dlr.de”","login":null,"count":136},{"name":"upad_aj","email":"ajay.upadhaya@dlr.de","login":"upadhayaajay","count":128},{"name":"Pedro Lacerda de Magalhães","email":"pedro.magalhaes@dlr.de","login":"thisandthatuser","count":126},{"name":"Sunke Schlüters","email":"sunke.schlueters@dlr.de","login":"sschlueters","count":123},{"name":"lschmeling","email":"lucas.schmeling@kehag.de","login":null,"count":45},{"name":"Patrik Schönfeldt","email":"gitlab@patrikschoenfeldt.de","login":null,"count":13},{"name":"Torio","email":"Herena.Torio@dlr.de","login":"htblanco","count":10},{"name":"Diana Maldonado","email":"Diana.Maldonado@dlr.de","login":null,"count":9},{"name":"dhun_go","email":"Oldenburg123","login":null,"count":7},{"name":"Keno Oltmanns","email":"keno.oltmanns@dlr.de","login":null,"count":5},{"name":"petr_ge","email":"geert.petrin@dlr.de","login":null,"count":5},{"name":"Alexander Hill","email":"alexander.hill@offis.de","login":"ahilloffis","count":3},{"name":"Patrik Schönfeldt","email":"git@patrikschoenfeldt.de","login":null,"count":3},{"name":"Hancock, Cody","email":"cody.hancock@dlr.de","login":null,"count":2},{"name":"Maldonado Castro, Diana Teresa","email":"diana.maldonado@dlr.de","login":null,"count":2},{"name":"Meike Kühnel","email":"meike.kuehnel@dlr.de","login":null,"count":2},{"name":"Turhan","email":"Elif.Turhan@dlr.de","login":null,"count":2},{"name":"Martin Krisch","email":"info@ichbinmartin.de","login":"ichbinmartin","count":2},{"name":"Tobias Brandt","email":"t.brandt91@gmail.com","login":"Tobii42","count":2},{"name":"Fernando Penaherrera","email":"fernandoandres.penaherreravaca@offis.de","login":null,"count":1},{"name":"Maximilian.Hillen@dlr.de","email":"maximilian.hillen@dlr.de","login":"MaxHiDLR","count":1},{"name":"gaik_na","email":"nachiket.gaikwad@dlr.de","login":"nachi10","count":1},{"name":"von Rüden","email":"lea.vonrueden@dlr.de","login":"vonrle","count":1}],"past_year_committers":[{"name":"Julius Ellermann","email":"julius.ellermann@dlr.de","login":null,"count":131},{"name":"Patrik Schönfeldt","email":"Patrik.Schoenfeldt@dlr.de","login":"p-snft","count":80},{"name":"Maldonado Castro, Diana Teresa","email":"“diana.maldonado@dlr.de”","login":null,"count":24},{"name":"Pedro Lacerda de Magalhães","email":"pedro.magalhaes@dlr.de","login":"thisandthatuser","count":20},{"name":"Torio","email":"Herena.Torio@dlr.de","login":"htblanco","count":10},{"name":"petr_ge","email":"geert.petrin@dlr.de","login":null,"count":5},{"name":"upad_aj","email":"ajay.upadhaya@dlr.de","login":"upadhayaajay","count":1}],"commits_url":"https://commits.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress/commits","host":{"name":"GitHub","url":"https://github.com","kind":"github","last_synced_at":"2026-04-07T00:00:11.408Z","repositories_count":6211373,"commits_count":920244725,"contributors_count":35656387,"owners_count":1142853,"icon_url":"https://github.com/github.png","host_url":"https://commits.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://commits.ecosyste.ms/api/v1/hosts/GitHub/repositories"}},"issues_stats":{"full_name":"mtress/mtress","html_url":"https://github.com/mtress/mtress","last_synced_at":"2026-03-21T19:01:22.329Z","status":"error","issues_count":17,"pull_requests_count":11,"avg_time_to_close_issue":11434055.7,"avg_time_to_close_pull_request":1475710.2727272727,"issues_closed_count":10,"pull_requests_closed_count":11,"pull_request_authors_count":2,"issue_authors_count":7,"avg_comments_per_issue":0.7647058823529411,"avg_comments_per_pull_request":0.36363636363636365,"merged_pull_requests_count":10,"bot_issues_count":0,"bot_pull_requests_count":0,"past_year_issues_count":1,"past_year_pull_requests_count":0,"past_year_avg_time_to_close_issue":null,"past_year_avg_time_to_close_pull_request":null,"past_year_issues_closed_count":0,"past_year_pull_requests_closed_count":0,"past_year_pull_request_authors_count":0,"past_year_issue_authors_count":1,"past_year_avg_comments_per_issue":1.0,"past_year_avg_comments_per_pull_request":null,"past_year_bot_issues_count":0,"past_year_bot_pull_requests_count":0,"past_year_merged_pull_requests_count":0,"created_at":"2023-05-14T18:10:58.170Z","updated_at":"2026-03-21T19:01:22.329Z","repository_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress","issues_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtress%2Fmtress/issues","issue_labels_count":{"enhancement":5,"good first issue":1,"bug":1},"pull_request_labels_count":{},"issue_author_associations_count":{"CONTRIBUTOR":11,"NONE":6},"pull_request_author_associations_count":{"CONTRIBUTOR":12},"issue_authors":{"p-snft":10,"BenHanke":2,"ahilloffis":1,"jhbruhn":1,"aghosh-debug":1,"sajonasra":1,"flpeters":1},"pull_request_authors":{"p-snft":10,"ahilloffis":2},"host":{"name":"GitHub","url":"https://github.com","kind":"github","last_synced_at":"2026-04-05T00:00:08.668Z","repositories_count":14078427,"issues_count":34459917,"pull_requests_count":112453351,"authors_count":11225674,"icon_url":"https://github.com/github.png","host_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories","owners_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/owners","authors_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors"},"past_year_issue_labels_count":{},"past_year_pull_request_labels_count":{},"past_year_issue_author_associations_count":{},"past_year_pull_request_author_associations_count":{},"past_year_issue_authors":{},"past_year_pull_request_authors":{},"maintainers":[],"active_maintainers":[]},"events":{"total":{"ReleaseEvent":1,"ForkEvent":1,"WatchEvent":4,"PushEvent":24,"CreateEvent":2},"last_year":{"ReleaseEvent":1,"WatchEvent":2,"PushEvent":20,"CreateEvent":2}},"keywords":[],"dependencies":[{"ecosystem":"pypi","filepath":"requirements.txt","sha":null,"kind":"manifest","created_at":"2022-08-12T00:50:31.315Z","updated_at":"2022-08-12T00:50:31.315Z","repository_link":"https://github.com/mtress/mtress/blob/dev/requirements.txt","dependencies":[{"id":1240734226,"package_name":"oemof.solph","ecosystem":"pypi","requirements":"\u003e0.4.2,\u003c0.5","direct":true,"kind":"runtime","optional":false},{"id":1240734227,"package_name":"oemof.thermal","ecosystem":"pypi","requirements":"\u003e=0.0.5","direct":true,"kind":"runtime","optional":false},{"id":1240734228,"package_name":"pandas","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false},{"id":1240734229,"package_name":"PyYAML","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false},{"id":1240734230,"package_name":"numpy","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false},{"id":1240734231,"package_name":"setuptools","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false}]},{"ecosystem":"pypi","filepath":"setup.py","sha":null,"kind":"manifest","created_at":"2022-08-12T00:50:31.536Z","updated_at":"2022-08-12T00:50:31.536Z","repository_link":"https://github.com/mtress/mtress/blob/dev/setup.py","dependencies":[{"id":1240740896,"package_name":"oemof.solph","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false},{"id":1240740897,"package_name":"oemof.thermal","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false},{"id":1240740898,"package_name":"pyyaml","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false},{"id":1240740899,"package_name":"pvlib","ecosystem":"pypi","requirements":"*","direct":true,"kind":"runtime","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/tox_pytests.yml","sha":null,"kind":"manifest","created_at":"2023-02-14T07:31:05.360Z","updated_at":"2023-02-14T07:31:05.360Z","repository_link":"https://github.com/mtress/mtress/blob/dev/.github/workflows/tox_pytests.yml","dependencies":[{"id":7649632652,"package_name":"actions/checkout","ecosystem":"actions","requirements":"v1","direct":true,"kind":"composite","optional":false},{"id":7649632653,"package_name":"actions/setup-python","ecosystem":"actions","requirements":"v2","direct":true,"kind":"composite","optional":false}]}],"score":6.309918278226517,"created_at":"2025-06-13T00:06:05.150Z","updated_at":"2026-04-08T03:30:20.746Z","avatar_url":"https://github.com/mtress.png","language":"Python","category":"Energy Systems","sub_category":"Renewable Energy Integration","monthly_downloads":0,"total_dependent_repos":0,"total_dependent_packages":0,"readme":"# Model Template for Renewable Energy Supply Systems (MTRESS)\n\n## Introduction\nThe DLR Institute of Networked Energy Systems has developed the MTRESS tool that can be \nused to optimise energy supply systems for new and existing projects at any location. \nMTRESS facilitates the creation of energy system optimisation models for individual \nresidential and commercial buildings, as well as for neighbourhoods and entire industrial\nproperties.  It enables users to include a wide range of influencing factors and energy\noptions in the simulation and minimises the planning effort.\n\nThis is a generic model for community-based open source [oemof.solph](https://github.com/oemof/oemof-solph/) tool.\nMTRESS offers a variety of possible technology combinations for energy supply systems.\nIt includes pre-built technologies that are commonly considered in energy systems, such as:\n - Photovoltaic or wind power (as generic RenewableEnergySource)\n - Grid Connection (Electricity, Heat and Gas)\n - Heat Pumps\n - Heat Exchangers\n - Electrolysers (PEM, Alkaline, AEM)\n - Fuel Cells (PEM, Alkaline, AEM)\n - Compressors\n - Combined Heat and Power (CHP) with various gas types and gas-mixtures (e.g., H2 + Natural Gas) as input fuels\n - Storages (Battery, Heat Storage, Gas Storage (Hydrogen))\n - Resistive Heater and Gas Boiler\n\nIt covers different sectors including Electricity, Heat and Gas (e.g., H2, Natural Gas,\nBiogas, etc.). It is tailored for optimising control strategies fulfilling fixed \ndemand time series for electricity, heat, gas (including hydrogen), and domestic hot \nwater using any selected combination of the implemented supply technologies.\n\nMTRESS requires appropriately prepared initial data on the boundary conditions of the \nrespective project. A wide range of data sources can be used, including \nhistorical energy consumption data for the project, but also higher-level data \non the location, for example from climate models or the solar cadastre. Moreover, the\nforecasted demands and renewable generations could also be used for scheduling optimized\noperation for next days. \nIt could be used for long-term planning and the assumptions about the development of \ncosts and the CO2 impact of the future energy mix can also be incorporated into the \nmodelling.\n\nAs an open-source model, MTRESS is available to users in a wide range of areas. It can\nbe utilized for both research and commercial purposes. Researchers, utility owners, and\npolicymakers can all benefit from this tool for energy system planning and operation. \nApplications are not just limited to municipal heating plans, home automation offerings,\nhydrogen infrastructure planning, and optimized operation of sector-coupled energy \nsystems, but extend to any scenario requiring comprehensive energy optimization and \nmanagement.\n\n## Installation\n\nMTRESS depends on solph, which is automatically installed using pip\n```bash \npip install mtress\n``` \nHowever, pip will not install a solver,\nto perform the actual optimisation. Please refer to the\n[documentation of solph](https://oemof-solph.readthedocs.io/en/stable/readme.html#installing-a-solver)\nto learn how to install a solver.\n\n## Documentation\n\nThe auto-generated documentation can be found on the [GitLab pages](https://mtress-ecosystem.pages.gitlab.dlr.de/mtress/api). \u003cbr\u003e\nThe coverage report can be found on the [GitLab pages](https://mtress-ecosystem.pages.gitlab.dlr.de/mtress/coverage) as well.\n\n## Usage and Tutorials\nPlease refer to the examples folder in this repository to get acquainted with building \nand optimizing energy systems in MTRESS. These examples will help you understand the \nbasics and guide you through the process before you start creating your own energy system. \n\nPlease feel free to contact us if you have any questions or need further assistance. \nContact information can be found below. \n\n## Acknowledgements\nThe development of Version 2 was funded by the Federal Ministry for Economic Affairs and Energy (BMWi)\nand the Federal Ministry of Education and Research (BMBF) of Germany\nin the project [ENaQ](https://www.enaq-fliegerhorst.de/) (project number 03SBE111).\nThe development of the heat sector formulations in Version 3 was funded by the Federal Ministry of\nEducation and Research (BMBF) of Germany in the project [Wärmewende Nordwest](https://www.waermewende-nordwest.de/) (project number 03SF0624).\nThe development of the gas sector formulations in Version 3 was funded by the Federal \nMinistry of Education and Research (BMBF) of Germany in the project [H2Giga-Systogen100](https://www.region-heide.de/projekte/systogen100.html)  (project number 03HY115E).\n\n## Contributing\n\nYou are welcome to contribute to MTRESS. We use\n[Black code style](https://black.readthedocs.io/) with 79 characters a line,\nand put our code under [MIT license](LICENSE). When contributing, you need to do the same.\nFor smaller changes, you can just open a merge request. If you plan something bigger,\nplease open an issue first, so that we can discuss beforehand and avoid double work. \nAlso, please report bugs by opening an issue.\n\n## Citation\nIf you use MTRESS Software for your research, please consider citation as follows using the\n[Zenodo record, doi:10.5281/zenodo.6395909](https://zenodo.org/doi/10.5281/zenodo.6395909).\n\n## Reference\n\u003ca id=\"1\"\u003e[1]\u003c/a\u003e\nSchönfeldt, Patrik and Schlüters, Sunke and Oltmanns, Keno,\"MTRESS 3.0--Modell Template for Residential Energy Supply Systems\",\narXiv preprint, 2022, [arXiv:2211.14080](https://arxiv.org/abs/2211.14080).\n\n## Contact\n\nThe software development is administrated by [Patrik Schönfeldt](mailto:patrik.schoenfeldt@dlr.de),\nfor general questions please contact him. Individual authors may leave their contact information\nin the [citation.cff](CITATION.cff).\n","funding_links":[],"readme_doi_urls":[],"works":{},"citation_counts":{},"total_citations":0,"keywords_from_contributors":["energy-system","modelling-framework"],"project_url":"https://ost.ecosyste.ms/api/v1/projects/318491","html_url":"https://ost.ecosyste.ms/projects/318491"}