Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

TEASER

Tool for Energy Analysis and Simulation for Efficient Retrofit.
https://github.com/rwth-ebc/teaser

Category: Consumption
Sub Category: Buildings and Heating

Keywords

buildings hacktoberfest python simulation urban-energy-modeling

Keywords from Contributors

modelica modelica-library bim ibpsa mpc urban-energy energy-networks urban city weatherdatacollection

Last synced: about 12 hours ago
JSON representation

Repository metadata

TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit

README.md

E.ON EBC RWTH Aachen University

TEASER - Tool for Energy Analysis and Simulation for Efficient Retrofit

License
Coverage Status
Build Status
Binder

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:

This GitHub page will be used to further develop the package and make it
available under the
MIT License.

If you have any questions regarding TEASER feel free to contact us at
[email protected].

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.

Version

TEASER is an ongoing research project, the current version is still a pre-release.

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/examples.

Dependencies

TEASER is currently tested against Python 3.7 up to 3.11. 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:

  1. https://winpython.github.io/ WinPython comes along with a lot of Python
    packages (e.g. SciPy, NumPy, pip, PyQT, etc.)..
  2. 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:

  1. Mako: template Engine
    install on a python-enabled command line with pip install -U mako
  2. pandas: popular data analysis library
    install on a python-enabled command line with pip install -U pandas
  3. 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.

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 metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 2,367
Total Committers: 44
Avg Commits per committer: 53.795
Development Distribution Score (DDS): 0.696

Commits in past year: 177
Committers in past year: 8
Avg Commits per committer in past year: 22.125
Development Distribution Score (DDS) in past year: 0.605

Name Email 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 29
Marcus Fuchs m****s@h****e 29
fabian.wuellhorst f****t@r****e 26
Jonatan Höpp j****p@e****e 18
[email protected] 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
Nicholas Long n****g@g****m 6
Peter Remmen P****n 6
Risch S****h@e****e 4
Remmen p****e@e****e 4
unknown j****e@E****e 4
mla-srs s****h@e****e 4
Diego Cordoba d****a@e****e 4
XucYin x****g@e****e 4
unknown p****e@L****e 3
pre-ygo p****o@E****e 3
and 14 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 432
Total pull requests: 396
Average time to close issues: 4 months
Average time to close pull requests: 24 days
Total issue authors: 60
Total pull request authors: 30
Average comments per issue: 2.49
Average comments per pull request: 1.93
Merged pull request: 340
Bot issues: 0
Bot pull requests: 0

Past year issues: 33
Past year pull requests: 42
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 15 days
Past year issue authors: 13
Past year pull request authors: 8
Past year average comments per issue: 0.3
Past year average comments per pull request: 0.64
Past year merged pull request: 33
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/rwth-ebc/teaser

Top Issue Authors

  • PRemmen (125)
  • mlauster (52)
  • MichaMans (50)
  • yGoerguelue (34)
  • DaJansenGit (30)
  • marcusfuchs (19)
  • MartinRaetz (12)
  • JSchiefelbein (10)
  • PGorzalka (8)
  • FWuellhorst (8)
  • RWTHSebastian (7)
  • HvanderStok (5)
  • AmeCode (4)
  • CGingter (3)
  • KremerMartin (3)

Top Pull Request Authors

  • PRemmen (134)
  • MichaMans (58)
  • DaJansenGit (47)
  • mlauster (40)
  • yGoerguelue (34)
  • FWuellhorst (15)
  • MartinRaetz (10)
  • marcusfuchs (10)
  • JSchiefelbein (8)
  • CGingter (6)
  • PGorzalka (4)
  • nhuelsenbeck (4)
  • HvanderStok (3)
  • HoeppJonatan (3)
  • larissakuehn (2)

Top Issue Labels

  • bug (86)
  • enhancement (79)
  • SolvedInDev (62)
  • GUI (52)
  • Logic (44)
  • Data (35)
  • help wanted (15)
  • critical (14)
  • Docu (10)
  • question (9)
  • wip 05 (8)
  • invalid (4)
  • hacktoberfest (1)
  • solved release05 (1)
  • persistent (1)

Top Pull Request Labels

  • bug (57)
  • GUI (37)
  • enhancement (30)
  • Logic (22)
  • Data (16)
  • wip 05 (6)
  • critical (5)
  • hacktoberfest (2)
  • hacktoberfest-accepted (1)
  • Docu (1)

Package metadata

pypi.org: teaser

Tool for Energy Analysis and Simulation for Efficient Retrofit

  • Homepage: https://github.com/RWTH-EBC/TEASER
  • Documentation: https://teaser.readthedocs.io/
  • Licenses: MIT
  • Latest release: 1.1.0 (published 4 months ago)
  • Last Synced: 2025-04-25T14:35:02.641Z (1 day ago)
  • Versions: 37
  • Dependent Packages: 1
  • Dependent Repositories: 6
  • Downloads: 1,649 Last month
  • Docker Downloads: 0
  • Rankings:
    • Dependent packages count: 3.242%
    • Docker downloads count: 3.836%
    • Forks count: 5.518%
    • Average: 5.742%
    • Dependent repos count: 6.115%
    • Stargazers count: 7.166%
    • Downloads: 8.574%
  • Maintainers (6)
proxy.golang.org: github.com/rwth-ebc/teaser

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/rwth-ebc/teaser#section-documentation
  • Licenses:
  • Latest release: v1.0.1 (published 5 months ago)
  • Last Synced: 2025-04-25T14:35:02.821Z (1 day ago)
  • Versions: 42
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 6.999%
    • Average: 8.173%
    • Dependent repos count: 9.346%
proxy.golang.org: github.com/RWTH-EBC/TEASER

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/RWTH-EBC/TEASER#section-documentation
  • Licenses: other
  • Latest release: v1.0.1 (published 5 months ago)
  • Last Synced: 2025-04-25T14:35:02.853Z (1 day ago)
  • Versions: 42
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 6.999%
    • Average: 8.173%
    • Dependent repos count: 9.346%

Dependencies

setup.py pypi
  • mako *
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
docs/requirements.txt pypi
  • autodoc_pydantic *
  • m2r2 *
  • numpydoc *
  • sphinx *
  • sphinx-material *
  • sphinx-rtd-theme >=1.3.0
  • sphinxcontrib.bibtex *

Score: 16.457461981361437