DistrictGenerator
An open-source, Python-based tool that provides urban planners, energy suppliers, and related professionals with essential insights into energy demands, enabling effective neighborhood energy system design and supply harmonization.
https://github.com/RWTH-EBC/districtgenerator
Category: Consumption
Sub Category: Buildings and Heating
Last synced: about 18 hours ago
JSON representation
Repository metadata
Tool for demand profile generation in districts
- Host: GitHub
- URL: https://github.com/RWTH-EBC/districtgenerator
- Owner: RWTH-EBC
- License: other
- Created: 2022-09-30T09:09:17.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-17T09:49:27.000Z (11 days ago)
- Last Synced: 2025-04-17T23:50:59.009Z (10 days ago)
- Language: Python
- Size: 74.3 MB
- Stars: 19
- Watchers: 12
- Forks: 6
- Open Issues: 30
- Releases: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
README.md
DistrictGenerator
Through the DistrictGenerator, we introduce an python-based open-source tool aimed at urban planners, energy suppliers,
housing associations, engineering firms, architectural professionals, as well as academic and research institutions.
This tool furnishes crucial insights into energy demands, pivotal for the effective design and operation of
neighborhoods energy systems. Consequently, users can discern actionable measures to harmonize energy supply.
The DistrictGenerator offers a pioneering approach by mapping entire urban
building stocks in neighborhood models for automated load profile calculations and dimensioning of distributed
energy resources. By integrating several open-source data bases and tools like TEASER
and richardsonpy.
The DistrictGenerator is being developed at RWTH Aachen University, E.ON Energy
Research Center, Institute for Energy Efficient Buildings and Indoor
Climate.
General Motivation
In the early stages of neighborhood planning, crucial data such as demand profiles of electricity, heating,
domestic hot water, and occupancy profiles are often not available. The absence of this data hampers
accurate evaluations of energy systems in districts. The DistrictGenerator seeks to advance the applicability
of sustainable, cross-sectoral energy systems in neighborhoods, with a specific emphasis on exploiting synergy
potentials among buildings of diverse usage structures through integrated concepts. We summarize the key contributions
of the DistrictGenerator as follows:
-
An open-source tool with minimal input requirements. Leveraging pre-set elements and default values of temporally
resolved demand profiles, as well as decentralized heat generator sizing conforming to DIN standards. -
The tool enables the bottom-up representation of entire urban structures through neighborhood models, affording a
sufficiently detailed analysis foundation. -
Facilitation of central operational optimization and presentation of analytical results and key performance
indicators. This supports the examination of various neighborhood types and supply scenarios concerning technology
selection and penetrations. We thereby create a platform for early-stage comparison of neighborhood concepts
with the flexibility of selecting different variants, given the tool's rapid recalculations.
Getting started
Install the DistrictGenerator
To install, first clone this repository with
git clone https://github.com/RWTH-EBC/districtgenerator
and secondly run:
pip install -e districtgenerator
Once you have installed the DistrictGenerator, you can check the examples
to learn how to use the different components.
Minimum required input data
To generate your district, you need to know some information about its buildings.
The minimal input data set was defined following the TABULA archetype approach:
- id: building ID (just numerate the buildings)
- building: residential building type (single family house, terraced house, multi family house or apartment block)
- year: construction year (the calendar year in which the building was constructed)
- retrofit: retrofit state according to TABULA (0: existing state, 1: usual refurbishment, 2: advanced refurbishment)
- area: reference floor area (given in square meters)
The example.csv file can be used as template.
What you get
After executing district generation you can find building-specific and time-dependent profiles in
the .csv format in folder results/demands. The results contain:
- heat: space heating demand
- dhw: domestic hot water demand
- elec: electricity demand for lighting and electric household devices
- occ: number of persons present
- gains: internal gains from persons, lighting and electric household devices
Structure of the DistrictGenerator
Running examples for functional testing
Once you have installed the DistrictGenerator, you can check the examples
to learn how to use the different components.
To test the tool's executability, run test_examples.py in the tests folder.
This functional testing checks the entire chain of the tool, from data input and
initialization to the output of the calculated profiles. It does not correspond to a
test of the functional units of the entire process. This functional testing is based
on the examples automatically executed one after another.
How to contribute
The documentation and examples should be understandable and the code bug-free.
As all users have different backgrounds, you may not understand everything or encounter bugs.
If you have questions, want to contribute new features or fix bugs yourself,
please raise an issue here.
If you wrote a new feature, create a pull request and assign
a reviewer before merging. Once review is finished, you can merge.
Authors
- Joel Schölzel (corresponding)
- Tobias Beckhölter
- Carla Wüller
Alumni
- Sarah Henn
Reference
We presented or applied the library in the following publications:
-
J. Schölzel, S. Henn, R. Streblow, D. Müller. Evaluation of Energy Sharing on a
Local Energy Market Through Comparison of Energy Management Techniques. 36th International
Conference on Efficiency, Cost, Optimization, Simulation and Environmental Impact of Energy Systems.
https://doi.org/10.52202/069564-0307 -
J. Schölzel, T. Beckhölter, S. Henn, C.Wüller, R. Streblow, D. Müller.
Districtgenerator: A Novel Open-Source Webtool to Generate Building-Specific Load
Profiles and Evaluate Energy Systems of Residential Districts. 37th International
Conference on Efficiency, Cost, Optimization, Simulation and Environmental Impact of
Energy Systems. -
C. Wüller, J. Schölzel, R. Streblow, D. Müller.Optimizing Local Energy Trading in Residential Neighborhoods:A Price Signal Approach
in Local Energy Markets. 37th International Conference on Efficiency, Cost, Optimization,
Simulation and Environmental Impact of Energy Systems.
License
The DistrictGenerator is released by RWTH Aachen University, E.ON Energy
Research Center, Institute for Energy Efficient Buildings and Indoor Climate,
under the MIT License.
Acknowledgements
The districtgenerator has been developed within the public funded project
"BF2020 Begleitforschung ENERGIEWENDEBAUEN - Modul Quartiere" (promotional reference: 03EWB003B)
and with financial support by BMWK (German Federal Ministry for Economic Affairs and Climate Action).
Owner metadata
- Name: RWTH Aachen University - E.ON Energy Research Center - Institute for Energy Efficient Buildings and Indoor Climate
- Login: RWTH-EBC
- Email: [email protected]
- Kind: organization
- Description:
- Website: http://www.ebc.eonerc.rwth-aachen.de/
- Location: RWTH Aachen University, Aachen, Germany
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/8121773?v=4
- Repositories: 52
- Last ynced at: 2024-03-27T11:18:30.715Z
- Profile URL: https://github.com/RWTH-EBC
GitHub Events
Total
- Create event: 29
- Commit comment event: 1
- Issues event: 53
- Watch event: 4
- Delete event: 24
- Member event: 2
- Issue comment event: 36
- Push event: 136
- Pull request review event: 4
- Pull request event: 36
- Fork event: 4
Last Year
- Create event: 29
- Commit comment event: 1
- Issues event: 53
- Watch event: 4
- Delete event: 24
- Member event: 2
- Issue comment event: 36
- Push event: 136
- Pull request review event: 4
- Pull request event: 36
- Fork event: 4
Committers metadata
Last synced: 8 days ago
Total Commits: 83
Total Committers: 8
Avg Commits per committer: 10.375
Development Distribution Score (DDS): 0.47
Commits in past year: 58
Committers in past year: 6
Avg Commits per committer in past year: 9.667
Development Distribution Score (DDS) in past year: 0.328
Name | Commits | |
---|---|---|
Joel Schölzel | j****l@e****e | 44 |
RawadHamze | r****e@e****e | 11 |
Marius | m****s@r****e | 11 |
Carla Wüller | c****r@e****e | 9 |
Marvin Kluge | 7****e | 3 |
Tobias Beckhölter | T****r@e****e | 2 |
Sarah | s****n@e****e | 2 |
carlawueller | 1****r | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 53
Total pull requests: 26
Average time to close issues: 27 days
Average time to close pull requests: 2 months
Total issue authors: 15
Total pull request authors: 7
Average comments per issue: 0.81
Average comments per pull request: 0.27
Merged pull request: 20
Bot issues: 0
Bot pull requests: 0
Past year issues: 47
Past year pull requests: 20
Past year average time to close issues: 27 days
Past year average time to close pull requests: 7 days
Past year issue authors: 12
Past year pull request authors: 5
Past year average comments per issue: 0.83
Past year average comments per pull request: 0.05
Past year merged pull request: 18
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- RawadHamze (11)
- jtock (9)
- c0nb4 (5)
- snjsomnath (5)
- marvin-kluge (4)
- carlawueller (4)
- JoelSchoelzel (3)
- ISHINJaR (2)
- lensum (2)
- AdamRJensen (2)
- TBeckhoelter (2)
- Ludee (1)
- hannahgoerigk (1)
- lwaer (1)
- DaJansenGit (1)
Top Pull Request Authors
- RawadHamze (11)
- marvin-kluge (5)
- ISHINJaR (2)
- lensum (2)
- carlawueller (2)
- c0nb4 (2)
- TBeckhoelter (2)
Top Issue Labels
Top Pull Request Labels
Dependencies
- matplotlib >=3.3.4
- numpy >=1.20.1
- pandas >=1.2.3
- pylightxl *
- richardsonpy *
- scipy >=1.6.1
- teaser *
- matplotlib *
- numpy *
- pandas *
- pylightxl *
- richardsonpy *
- scipy *
- teaser *
- matplotlib *
- numpy *
- pandas *
- pylightxl *
- richardsonpy *
- scipy *
- teaser *
- myst-parser *
- sphinx *
- sphinx_rtd_theme *
Score: 5.971261839790462