Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: mdpi.com, zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.5%) to scientific vocabulary
Repository
Compact Energy System Modeling Tool
Basic Info
- Host: GitHub
- Owner: EINS-TUDa
- License: mit
- Language: Python
- Default Branch: main
- Size: 10.9 MB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 7
- Releases: 1
Metadata Files
README.md
Compact Energy System Modeling Tool (CESM)
This is a compact energy system modeling tool that can model different forms of energy carriers and the conversion processes that convert them to each other. The optimal output of the model determines how much should be invested in each part of the energy system to meet the energy demand and minimize costs.
An example of the German energy system is also provided. The results of the model are compatible with the results of the paper "Barbosa, Julia, Christopher Ripp, and Florian Steinke. Accessible Modeling of the German Energy Transition: An Open, Compact, and Validated Model. Energies 14, no. 23 (2021)"

Doucmentation: https://cesm.readthedocs.io
Installation
Download and install the following software from their official websites:
- Python (version 3.10 or above)
- Gurobi
Set up a virtual environment: ```console
python -m venv env env\Scripts\activate
Clone the repository: ```console
git clone https://github.com/EINS-TUDa/CESM.git ```
Change the directory to the repository: ```console
cd CESM ```
Install the package: ```console
pip install -e . ```
Quick Start
Initialize the Runs directory: ```console
cesm init ```
Run the available models located in the Data folder using the following command: ```console
cesm run ```
If you know the specific model to be run, you can alternatively use: ```console
cesm run -m $MODEL_NAME -s $SCENARIO ```
After the run is finished, plot the results with the following command: ```console
cesm plot ``` These steps will help you quickly set up and start using the Compact Energy System Modelling Tool (CESM).
Documentation
You can find our documentation online or build it yourself:
- Install documentation requirements:
console > pip install -r docs\requirements.txt - Make build documentation:
console > docs\make html
Then you can open the documentation from docs/build/html/index.html.
Authors
Roadmap
- [ ] Tests
- [ ] Design simple examples
- [ ] Saving the results
- [ ] Postprocessing code
- [ ] Implementing the model in other libraries(Pyomo, AMPL, ...)
Citation
If you use this software in your research, please cite this repository. If you use the German energy transition model in your research, please cite the original paper:
Barbosa, J.; Ripp, C.; Steinke, F. Accessible Modeling of the German Energy Transition: An Open, Compact, and Validated Model. Energies 2021, 14, 8084. https://doi.org/10.3390/en14238084
For Bibtex you can use the following:
@Article{en14238084,
AUTHOR = {Barbosa, Julia and Ripp, Christopher and Steinke, Florian},
TITLE = {Accessible Modeling of the German Energy Transition: An Open, Compact, and Validated Model},
JOURNAL = {Energies},
VOLUME = {14},
YEAR = {2021},
NUMBER = {23},
ARTICLE-NUMBER = {8084},
URL = {https://www.mdpi.com/1996-1073/14/23/8084},
ISSN = {1996-1073},
ABSTRACT = {We present an easily accessible model for dispatch and expansion planning of the German multi-modal energy system from today until 2050. The model can be used with low efforts while comparing favorably with historic data and other studies of future developments. More specifically, the model is based on a linear programming partial equilibrium framework and uses a compact set of technologies to ease the comprehension for new modelers. It contains all equations and parameters needed, with the data sources and model assumptions documented in detail. All code and data are openly accessible and usable. The model can reproduce today’s energy mix and its CO2 emissions with deviations below 10%. The generated energy transition path, for an 80% CO2 reduction scenario until 2050, is consistent with leading studies on this topic. Our work thus summarizes the key insights of previous works and can serve as a validated and ready-to-use platform for other modelers to examine additional hypotheses.},
DOI = {10.3390/en14238084}
}
License
The project is licensed under the MIT license - see the LICENSE.md file for details.
Owner
- Name: EINS-TUDa
- Login: EINS-TUDa
- Kind: organization
- Repositories: 1
- Profile: https://github.com/EINS-TUDa
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: Compact Energy System Modeling Tool (CESM)
message: '"If you use this software, please cite it as below."'
type: software
identifiers:
- type: doi
value: 10.5281/zenodo.13902515
version: 0.0.9
authors:
- given-names: Sina
family-names: Hajikazemi
email: sina.hkazemi@gmail.com
affiliation: Technical University of Darmstadt
orcid: 'https://orcid.org/0009-0000-1455-9890'
- given-names: Julia
family-names: Barbosa
affiliation: Technical University of Darmstadt
email: julia.barbosa@eins.tu-darmstadt.de
repository-code: 'https://github.com/EINS-TUDa/CESM'
abstract: >-
This is a compact energy system modeling tool that can
model different forms of energy carriers and the
conversion processes that convert them to each other. The
optimal output of the model determines how much should be
invested in each part of the energy system to meet the
energy demand and minimize costs.
An example of the German energy system is also provided.
The results of the model are compatible with the results
of the paper "Barbosa, Julia, Christopher Ripp, and
Florian Steinke. Accessible Modeling of the German Energy
Transition: An Open, Compact, and Validated Model.
Energies 14, no. 23 (2021)"
keywords:
- Energy
- Planning
license: MIT
GitHub Events
Total
- Issues event: 1
- Delete event: 1
- Push event: 4
- Create event: 1
Last Year
- Issues event: 1
- Delete event: 1
- Push event: 4
- Create event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 457 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 7
- Total maintainers: 1
pypi.org: cesm
Compact Energy System Modeling Tool (CESM)
- Homepage: https://github.com/EINS-TUDa/CESM
- Documentation: https://cesm.readthedocs.io/
- License: MIT
-
Latest release: 0.0.7
published about 2 years ago
Rankings
Maintainers (1)
Dependencies
- sphinx *
- sphinx-book-theme *
- gurobipy *
- numpy *
- openpyxl *
- pandas *
- pydantic *
- scipy *