teaser
TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: researchgate.net -
✓Committers with academic emails
36 of 46 committers (78.3%) from academic institutions -
✓Institutional organization owner
Organization rwth-ebc has institutional domain (www.ebc.eonerc.rwth-aachen.de) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.4%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit
Basic Info
Statistics
- Stars: 130
- Watchers: 27
- Forks: 72
- Open Issues: 64
- Releases: 51
Topics
Metadata Files
README.md
TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit
TEASER (Tool for Energy Analysis and Simulation for Efficient Retrofit) allows fast generation of archetype buildings with low input requirements and the export of individual dynamic simulation models for the below-mentioned Modelica libraries. These libraries all use the framework of Modelica IBPSA library. TEASER is being developed at the RWTH Aachen University, E.ON Energy Research Center, Institute for Energy Efficient Buildings and Indoor Climate.
The full documentation of TEASER including examples and description of modules, classes and functions can be found at the website:
- http://rwth-ebc.github.io/TEASER/
If you have any questions regarding TEASER feel free to contact us at ebc-tools@eonerc.rwth-aachen.de.
Description
Energy supply of buildings in urban context currently undergoes significant changes. The increase of renewable energy sources for electrical and thermal energy generation will require flexible and secure energy storage and distribution systems. To reflect and consider these changes in energy systems and buildings, dynamic simulation is one key element, in particular when it comes to thermal energy demand on minutely or hourly scale. Sparse and limited access to detailed building information as well as computing times are challenges for building simulation on urban scale. In addition, data acquisition and modeling for Building Performance Simulation (BPS) are time consuming and error-prone. To enable the use of BPS on urban scale we present the TEASER tool, an open framework for urban energy modeling of building stocks. TEASER provides an easy interface for multiple data sources, data enrichment (where necessary) and export of ready-to-run Modelica simulation models for all libraries supporting the Modelica IBPSA library.
How to use TEASER
Examples and jupyter notebooks
We provide different examples to show the usage of TEASER. Check out the files under teaser/examples or the jupyter-notebooks available here: docs/jupyter_notebooks. If you just want to read the example on github, check them here: docs/source/jupyter_notebooks.
Dependencies
TEASER is currently tested against Python 3.7 up to 3.12. Older versions of Python may still work, but are no longer actively supported. Using a Python distribution is recommended as they already contain (or easily support installation of) many Python packages (e.g. SciPy, NumPy, pip, PyQT, etc.) that are used in the TEASER code. Two examples of those distributions are:
- https://winpython.github.io/ WinPython comes along with a lot of Python packages (e.g. SciPy, NumPy, pip, PyQT, etc.)..
- http://conda.pydata.org/miniconda.html Conda is an open source package management system and environment management system for installing multiple versions of software packages and their dependencies and switching easily between them.
In addition, TEASER requires some specific Python packages:
- Mako: template Engine
install on a python-enabled command line with
pip install -U mako - pandas: popular data analysis library
install on a python-enabled command line with
pip install -U pandas - pytest: Unit Tests engine
install on a python-enabled command line with
pip install -U pytest
Installation
The best option to install TEASER is to use pip:
pip install teaser
If you actively develop TEASER you can clone this repository by using:
git clone [SSH-Key/Https]
and then run:
pip install -e [Path/to/your/Teaser/Clone] which will install the local version of TEASER.
How to contribute to the development of TEASER
You are invited to contribute to the development of TEASER. You may report any issues by using the Issues button. Furthermore, you are welcome to contribute via Pull Requests. The workflow for changes is described in our Wiki.
How to cite TEASER
- 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, pdf, bibtex
TEASER related publications
CityGML Import and Export for Dynamic Building Performance Simulation in Modelica. Remmen P., Lauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016, pdf, bibtex
Scalable Design-Driven Parameterization of Reduced Order Models Using Archetype Buildings with TEASER. Lauster M., Mans M., Remmen P., Fuchs M., Müller D.. BauSIM2016, p.535-542, September 2016, pdf
Refinement of Dynamic Non-Residential Building Archetypes Using Measurement Data and Bayesian Calibration Remmen P., Schäfer J., Müller D.. Building Simulation 2019, September 2019, pdf
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
The Institute of Energy Efficiency and Sustainable Building published a parametric study of TEASER where all functions and parameters used in TEASER are gathered and explained. The publication can be found here.
“Modeling District Heating and Cooling Systems with URBANopt, GeoJSON to Modelica Translator, and the Modelica Buildings Library.” Long, Nicholas, Antoine Gautier, Hagar Elarga, Amy Allen, Ted Summer, Lauren Klun, Nathan Moore, and Michael Wetter. 2021. In Building Simulation 2021, 8. Bruges, Brussels. https://docs.urbanopt.net/docfiles/modelingdes_paper.pdf.
License
TEASER is released by RWTH Aachen University, E.ON Energy Research Center, Institute for Energy Efficient Buildings and Indoor Climate, under the MIT License.
Acknowledgements
This work was supported by the Helmholtz Association under the Joint Initiative “Energy System 2050 – A Contribution of the Research Field Energy”.
Parts of TEASER have been developed within public funded projects and with financial support by BMWi (German Federal Ministry for Economic Affairs and Energy).
Owner
- Name: RWTH Aachen University - E.ON Energy Research Center - Institute for Energy Efficient Buildings and Indoor Climate
- Login: RWTH-EBC
- Kind: organization
- Email: david.jansen@eonerc.rwth-aachen.de
- Location: RWTH Aachen University, Aachen, Germany
- Website: http://www.ebc.eonerc.rwth-aachen.de/
- Repositories: 52
- Profile: https://github.com/RWTH-EBC
GitHub Events
Total
- Create event: 37
- Release event: 8
- Issues event: 42
- Watch event: 14
- Delete event: 26
- Issue comment event: 40
- Push event: 235
- Pull request review event: 52
- Pull request review comment event: 37
- Pull request event: 56
- Fork event: 3
Last Year
- Create event: 37
- Release event: 8
- Issues event: 42
- Watch event: 14
- Delete event: 26
- Issue comment event: 40
- Push event: 235
- Pull request review event: 52
- Pull request review comment event: 37
- Pull request event: 56
- Fork event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| PRemmen | P****n@e****e | 720 |
| PRemmen | P****n@e****e | 257 |
| mlauster | m****r@e****e | 187 |
| MichaMans | m****s@h****m | 185 |
| David | d****1@r****e | 172 |
| yGoerguelue | y****e@r****e | 153 |
| mla-mmn | m****s@e****e | 150 |
| pre-ygo | p****o@E****e | 130 |
| Hendrik van der Stok | h****k@r****e | 70 |
| Philip Gorzalka | p****a@d****e | 48 |
| Martin Rätz | m****z@r****e | 46 |
| mla-cgi | m****i@E****e | 33 |
| fabian.wuellhorst | f****t@e****e | 31 |
| Marcus Fuchs | m****s@h****e | 29 |
| fabian.wuellhorst | f****t@r****e | 26 |
| Jonatan Höpp | j****p@e****e | 18 |
| marvin.kluge | m****e@e****e | 18 |
| fabian.wuellhorst@eonerc.rwth-aachen.de | F****t | 17 |
| Jonas Reuter-Schniete | j****e@r****e | 11 |
| jsc-tbe | T****r@e****e | 10 |
| Alessandro Maccarini | a****m@s****k | 7 |
| Peter Remmen | P****n | 6 |
| Nicholas Long | n****g@g****m | 6 |
| Diego Cordoba | d****a@e****e | 4 |
| XucYin | x****g@e****e | 4 |
| unknown | j****e@E****e | 4 |
| Remmen | p****e@e****e | 4 |
| Risch | S****h@e****e | 4 |
| mla-srs | s****h@e****e | 4 |
| Beckhoelter | j****e@e****e | 3 |
| and 16 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 432
- Total pull requests: 410
- Average time to close issues: 4 months
- Average time to close pull requests: 24 days
- Total issue authors: 63
- Total pull request authors: 33
- Average comments per issue: 2.49
- Average comments per pull request: 1.87
- Merged pull requests: 348
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 29
- Pull requests: 47
- Average time to close issues: about 1 month
- Average time to close pull requests: 24 days
- Issue authors: 12
- Pull request authors: 9
- Average comments per issue: 0.21
- Average comments per pull request: 0.6
- Merged pull requests: 33
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- PRemmen (124)
- mlauster (52)
- MichaMans (50)
- yGoerguelue (33)
- DaJansenGit (26)
- marcusfuchs (19)
- MartinRaetz (12)
- JSchiefelbein (10)
- PGorzalka (8)
- FWuellhorst (7)
- RWTHSebastian (7)
- HvanderStok (6)
- AmeCode (4)
- larissakuehn (3)
- HoeppJ (3)
Pull Request Authors
- PRemmen (134)
- DaJansenGit (67)
- MichaMans (58)
- mlauster (40)
- yGoerguelue (34)
- FWuellhorst (24)
- MartinRaetz (11)
- marcusfuchs (11)
- JSchiefelbein (8)
- PGorzalka (6)
- CGingter (6)
- HvanderStok (5)
- HoeppJonatan (4)
- nhuelsenbeck (4)
- jonas0902 (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 1,686 last-month
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 6
(may contain duplicates) - Total versions: 127
- Total maintainers: 6
pypi.org: teaser
Tool for Energy Analysis and Simulation for Efficient Retrofit
- Homepage: https://github.com/RWTH-EBC/TEASER
- Documentation: https://teaser.readthedocs.io/
- License: MIT
-
Latest release: 1.3.0
published 6 months ago
Rankings
proxy.golang.org: github.com/rwth-ebc/teaser
- Documentation: https://pkg.go.dev/github.com/rwth-ebc/teaser#section-documentation
- License: other
-
Latest release: v1.3.0
published 6 months ago
Rankings
proxy.golang.org: github.com/RWTH-EBC/TEASER
- Documentation: https://pkg.go.dev/github.com/RWTH-EBC/TEASER#section-documentation
- License: other
-
Latest release: v1.3.0
published 6 months ago
Rankings
Dependencies
- mako *
- actions/checkout v2 composite
- github/codeql-action/analyze v1 composite
- github/codeql-action/autobuild v1 composite
- github/codeql-action/init v1 composite
- autodoc_pydantic *
- m2r2 *
- numpydoc *
- sphinx *
- sphinx-material *
- sphinx-rtd-theme >=1.3.0
- sphinxcontrib.bibtex *