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

tsib

A Python package that builds up on different databases and models for creating consistent demand and production time series of residential buildings.
https://github.com/FZJ-IEK3-VSA/tsib

Category: Consumption
Sub Category: Buildings and Heating

Last synced: about 20 hours ago
JSON representation

Repository metadata

Time Series Initialization of Buildings

README.md

Build Status
Version

tsib - Time Series Initialization for Buildings

tsib is a python package that builds up on different databases and models for creating consistent demand and production time series of residential buildings. This could be either occupancy behavior, electricity demand or heat demand time series as well as photovoltaic (PV) and solar thermal production time series.

If you want to use tsib in a published work, please cite following publication which applies tsib for the creation of time series for residential buildings in Germany.

Features

  • flexible configuration of single buildings by different input arguments
  • simple building definition based on an archetype building catalogue
  • consideration of the occupancy behavior
  • derivation of the electric device load or the demand for thermal comfort
  • calculation of the heat load based on a thermal building model
  • provision of location specific time series for solar irradiation and temperature based on weather data

Applied databases and models

tsib is a flexible tool which allows the use of different models and databases for the generation of time series for buildings. In Version 0.1.0 the following databases and models are included is tsib:

  • CREST demand model for the simulaton of the occupancy behavior
  • 5R1C thermal building model
  • pvlib for solar irradiance calculation and photovoltaic simulation
  • TABULA/EPISCOPE archetype building catalogue
  • DWD Testreferenzjahre for providing weather data

Installation

Directly install via pip as follows:

pip install tsib

Alternatively, clone a local copy of the repository to your computer

git clone https://github.com/FZJ-IEK3-VSA/tsib.git

Then install tsib via pip as follow

cd tsib
pip install . 

Or install directly via python as

python setup.py install

In order to use the 5R1C thermal building model, make sure that you have installed a MILP solver. As default solver coin-cbc is used which can either installed by

sudo apt-get install coinor-cbc

or for Anaconda under windows as

conda install -c conda-forge coincbc

. Other solvers can be defined by defining the environment variable $SOLVER.

To get flexible weather data from the Climate Data Store, register here and follow the instructions to get an own key. Make sure that you have agreed on the license terms.

Examples

This jupyter notebook shows the capabilites of tsib to create all relevant time series.

License

MIT License

Copyright (C) 2016-2022 Leander Kotzur (FZJ IEK-3), Timo Kannengießer (FZK-IEK-3), Kevin Knosala (FZJ IEK-3), Peter Stenzel (FZJ IEK-3), Peter Markewitz (FZJ IEK-3), Martin Robinius (FZJ IEK-3), Detlef Stolten (FZJ IEK-3)

You should have received a copy of the MIT License along with this program.
If not, see https://opensource.org/licenses/MIT

About Us

Acknowledgement

This work was supported by the Helmholtz Association under the Joint Initiative "Energy System 2050 A Contribution of the Research Field Energy".


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 121
Total Committers: 6
Avg Commits per committer: 20.167
Development Distribution Score (DDS): 0.182

Commits in past year: 8
Committers in past year: 1
Avg Commits per committer in past year: 8.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Leander l****r@g****m 99
Kevin Knosala k****a@f****e 13
Kevin Knosala k****a@i****e 5
Stenzel, Peter p****l@f****e 2
Julian Schönau 6****e 1
noah80 n****0 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 0
Total pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: 8 days
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull request: 2
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
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: 0
Past year pull request authors: 0
Past year average comments per issue: 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/FZJ-IEK3-VSA/tsib

Top Issue Authors

Top Pull Request Authors

  • noah80 (1)
  • OfficialCodexplosive (1)

Top Issue Labels

Top Pull Request Labels


Package metadata

pypi.org: tsib

Time Series Initialization for Buildings

  • Homepage: https://github.com/FZJ-IEK3-VSA/tsib
  • Documentation: https://tsib.readthedocs.io/
  • Licenses: MIT License
  • Latest release: 0.1.6 (published about 2 years ago)
  • Last Synced: 2025-04-26T12:30:27.288Z (2 days ago)
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 254 Last month
  • Rankings:
    • Dependent packages count: 7.31%
    • Forks count: 10.554%
    • Stargazers count: 14.227%
    • Average: 16.059%
    • Dependent repos count: 22.088%
    • Downloads: 26.116%
  • Maintainers (1)

Dependencies

requirements.txt pypi
  • Pyomo >=4.2
  • cdsapi *
  • matplotlib >=3.0.0
  • numpy *
  • pandas >=0.24.0
  • pvlib >=0.7.0
  • tinydb *
  • tsam >=1.0.4
  • tsorb *
  • xlrd *
setup.py pypi

Score: 10.281375892874058