{"id":13723515,"url":"https://github.com/RWTH-EBC/TEASER","last_synced_at":"2025-05-07T16:32:59.460Z","repository":{"id":41081458,"uuid":"44748744","full_name":"RWTH-EBC/TEASER","owner":"RWTH-EBC","description":"TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit","archived":false,"fork":false,"pushed_at":"2025-04-29T16:05:51.000Z","size":80377,"stargazers_count":126,"open_issues_count":68,"forks_count":71,"subscribers_count":27,"default_branch":"main","last_synced_at":"2025-05-02T18:00:12.041Z","etag":null,"topics":["buildings","hacktoberfest","python","simulation","urban-energy-modeling"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RWTH-EBC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"License.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-10-22T13:57:56.000Z","updated_at":"2025-04-29T15:57:06.000Z","dependencies_parsed_at":"2023-09-21T19:33:20.021Z","dependency_job_id":"fda5fde6-e39d-4ef3-a0b0-5470c1fb0ff4","html_url":"https://github.com/RWTH-EBC/TEASER","commit_stats":{"total_commits":2107,"total_committers":39,"mean_commits":54.02564102564103,"dds":0.65828191741813,"last_synced_commit":"4120e6a60e8e0101ba5e3e86ffd5b05802b0e09d"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FTEASER","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FTEASER/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FTEASER/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FTEASER/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RWTH-EBC","download_url":"https://codeload.github.com/RWTH-EBC/TEASER/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252231167,"owners_count":21715474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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"}},"keywords":["buildings","hacktoberfest","python","simulation","urban-energy-modeling"],"created_at":"2024-08-03T01:01:42.456Z","updated_at":"2025-05-07T16:32:59.441Z","avatar_url":"https://github.com/RWTH-EBC.png","language":"Python","funding_links":[],"categories":["Energy Models (Frameworks and libraries)","Consumption","Energy Consumption"],"sub_categories":["Buildings and Heating","Buildings and Cities"],"readme":"![E.ON EBC RWTH Aachen University](docs/source/_static/EBC_Logo.png)\n\n# TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit\n\n[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)\n[![Coverage Status](https://coveralls.io/repos/github/RWTH-EBC/TEASER/badge.svg)](https://coveralls.io/github/RWTH-EBC/TEASER)\n[![Build Status](https://travis-ci.org/RWTH-EBC/TEASER.svg?branch=main)](https://travis-ci.org/RWTH-EBC/TEASER.svg?branch=main)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/main?labpath=docs%2Fjupyter_notebooks)\n\nTEASER (Tool for Energy Analysis and Simulation for Efficient Retrofit) allows\nfast generation of archetype buildings with low input requirements and the\nexport of individual dynamic simulation models for the below-mentioned Modelica\nlibraries. These libraries all use the framework of [Modelica IBPSA\nlibrary](https://github.com/ibpsa/modelica). TEASER is being developed at the\n[RWTH Aachen University, E.ON Energy Research Center, Institute for Energy\nEfficient Buildings and Indoor\nClimate](https://www.ebc.eonerc.rwth-aachen.de/cms/~dmzz/E-ON-ERC-EBC/?lidx=1).\n\n * [AixLib](https://github.com/RWTH-EBC/AixLib)\n * [BESMod](https://github.com/RWTH-EBC/BESMod)\n * [Buildings](https://github.com/lbl-srg/modelica-buildings)\n * [BuildingSystems](https://github.com/UdK-VPT/BuildingSystems)\n * [IDEAS](https://github.com/open-ideas/IDEAS).\n\nThe full documentation of TEASER including examples and description of modules,\nclasses and functions can be found at the website:\n\n * http://rwth-ebc.github.io/TEASER/\n\nThis GitHub page will be used to further develop the package and make it\navailable under the\n[MIT License](https://github.com/RWTH-EBC/TEASER/blob/main/License.md).\n\nIf you have any questions regarding TEASER feel free to contact us at\n[ebc-teaser@eonerc.rwth-aachen.de](mailto:ebc-teaser@eonerc.rwth-aachen.de).\n\n\n## Description\n\nEnergy supply of buildings in urban context currently undergoes significant\nchanges. The increase of renewable energy sources for electrical and thermal\nenergy generation will require flexible and secure energy storage and\ndistribution systems. To reflect and consider these changes in energy systems\nand buildings, dynamic simulation is one key element, in particular when it\ncomes to thermal energy demand on minutely or hourly scale.\nSparse and limited access to detailed building information as well as computing\ntimes are challenges for building simulation on urban scale. In addition,\ndata acquisition and modeling for Building Performance Simulation (BPS) are\ntime consuming and error-prone. To enable the use of BPS on urban scale we\npresent the TEASER tool, an open framework for urban energy modeling of\nbuilding stocks. TEASER provides an easy interface for multiple data sources,\ndata enrichment (where necessary) and export of ready-to-run Modelica simulation\nmodels for all libraries supporting the\n[Modelica IBPSA library](https://github.com/ibpsa/modelica).\n\n\n## Version\n\nTEASER is an ongoing research project, the current version is still a pre-release.\n\n## How to use TEASER\n\n### Examples and jupyter notebooks\n\nWe provide different examples to show the usage of TEASER.\nCheck out the files under teaser/examples or the jupyter-notebooks available here: docs/jupyter-notebooks.\nIf you just want to read the example on github, check them here: docs/examples.\n\n### Dependencies\n\nTEASER is currently tested against Python 3.7 up to 3.11. Older versions of Python may\nstill work, but are no longer actively supported.\nUsing a Python distribution is recommended as they already contain (or easily\nsupport installation of) many Python packages (e.g. SciPy, NumPy, pip, PyQT,\netc.) that are used in the TEASER code. Two examples of those distributions are:\n\n1. https://winpython.github.io/ WinPython comes along with a lot of Python\npackages (e.g. SciPy, NumPy, pip, PyQT, etc.)..\n2. http://conda.pydata.org/miniconda.html Conda is an open source package\nmanagement  system and environment management system for installing multiple\nversions of software  packages and their dependencies and switching easily\nbetween them.\n\nIn addition, TEASER requires some specific Python packages:\n\n1. Mako: template Engine\n  install on a python-enabled command line with `pip install -U mako`\n2. pandas: popular data analysis library\n  install on a python-enabled command line with `pip install -U pandas`\n3. pytest: Unit Tests engine\n  install on a python-enabled command line with `pip install -U pytest`\n\n### Installation\n\nThe best option to install TEASER is to use pip:\n\n`pip install teaser`\n\nIf you actively develop TEASER you can clone this repository by using:\n\n `git clone [SSH-Key/Https]`\n\nand then run:\n\n `pip install -e [Path/to/your/Teaser/Clone]` which will install the local version of TEASER.\n\n\n### How to contribute to the development of TEASER\nYou are invited to contribute to the development of TEASER. You may report any issues by using the [Issues](https://github.com/RWTH-EBC/TEASER/issues) button.\nFurthermore, you are welcome to contribute via [Pull Requests](https://github.com/RWTH-EBC/TEASER/pulls).\nThe workflow for changes is described in our [Wiki](https://github.com/RWTH-EBC/TEASER/wiki).\n\n## How to cite TEASER\n\n+ TEASER: an open tool for urban energy modelling of building stocks. Remmen P., Lauster M., Mans M., Fuchs M., Osterhage T., Müller D.. Journal of Building Performance Simulation, February 2017,\n[pdf](http://dx.doi.org/10.1080/19401493.2017.1283539),\n[bibtex](https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite_jbps.bib)\n\n### TEASER related publications\n\n+ CityGML Import and Export for Dynamic Building Performance Simulation in Modelica. Remmen P.,\nLauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016,\n[pdf](http://www.ibpsa.org/proceedings/BSO2016/p1047.pdf),\n[bibtex](https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite.bib)\n\n+ Scalable Design-Driven Parameterization of Reduced Order Models Using Archetype Buildings with TEASER.\nLauster M., Mans M., Remmen P., Fuchs M., Müller D.. BauSIM2016, p.535-542, September 2016,\n[pdf](https://www.researchgate.net/profile/Moritz_Lauster/publication/310465372_Scalable_Design-Driven_Parameterization_of_Reduced_Order_Models_using_Archetype_Buildings_with_TEASER/links/582ee96908ae004f74be1fb0.pdf?origin=publication_detail\u0026ev=pub_int_prw_xdl\u0026msrp=eEyK6WYemhC8wK7xkMEPRDO4obE4uxBN4-0BdBy1Ldwhy9FhCe1pXfNObJYubvC_aZN0IWDPf9uayBo3u79bsZvg3hzUoLoYRatES2ARH8c.B2cYwSICt0IOa7lD-4oAiEa_3TtrO-7k-1W9chuNQwr_VNMCpZ5ubSb-eY2D77rGUP4S6wS8m6vudUUbMlXbQQ.Cledgd1Q9fPp11nYGpcpKNhSS6bVTqAEXeMZPkiV3HsJxcVWTFj4Hr_jmLZ0MOzDxbDEZObcGiKfmTL_9k_59A)\n\n+ Refinement of Dynamic Non-Residential Building Archetypes Using Measurement Data and Bayesian Calibration\nRemmen P., Schäfer J., Müller D.. Building Simulation 2019, September 2019,\n[pdf](https://www.researchgate.net/publication/337925776_Refinement_of_Dynamic_Non-Residential_Building_Archetypes_Using_Measurement_Data_and_Bayesian_Calibration)\n\n+ Selecting statistical indices for calibrating building energy models. Vogt, M., Remmen P., Lauster M., Fuchs M. , Müller D.. Building and Environment 144, pages 94-107, October 2018. [bibtex](https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite_be.bib)\n\n+ The [Institute of Energy Efficiency and Sustainable Building](https://www.e3d.rwth-aachen.de/go/id/iyld/?) published a parametric study of TEASER where all functions and  parameters used in TEASER are gathered and explained. The publication can be found [here](https://publications.rwth-aachen.de/record/749801/files/749801.pdf).\n\n\n## License\n\nTEASER is released by RWTH Aachen University, E.ON Energy\nResearch Center, Institute for Energy Efficient Buildings and Indoor Climate,\nunder the\n[MIT License](https://github.com/RWTH-EBC/TEASER/blob/main/License.md).\n\n## Acknowledgements\n\nThis  work  was  supported  by  the  Helmholtz  Association  under  the  Joint  Initiative  “Energy System 2050 – A Contribution of the Research Field Energy”.\n\nParts of TEASER have been developed within public funded projects\nand with financial support by BMWi (German Federal Ministry for Economic\nAffairs and Energy).\n\n\u003cimg src=\"https://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg?__blob=normal\" width=\"200\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRWTH-EBC%2FTEASER","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRWTH-EBC%2FTEASER","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRWTH-EBC%2FTEASER/lists"}