The Spreadsheet Energy System Model Generator (SESMG)
The Spreadsheet Energy System Model Generator (SESMG): A tool for the optimization of urban energy systems - Published in JOSS (2023)
Science Score: 100.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 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
4 of 23 committers (17.4%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Model generator for the optimization of energy systems, based on the modeling framework oemof. No programming skills are required to use it, as the parameters are entered using spreadsheets (e.g. Excel, LibreOffice).
Basic Info
- Host: GitHub
- Owner: SESMG
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Size: 324 MB
Statistics
- Stars: 22
- Watchers: 4
- Forks: 20
- Open Issues: 49
- Releases: 20
Metadata Files
README.md
Spreadsheet Energy System Model Generator (SESMG)
Software Description
The SESMG is an energy system model generator with the focus on the optimization of urban energy systems, which can, however, also be used for the modeling of other types of energy systems. The SESMG is based on the 'Open Energy Modelling Framework' (oemof) and comes, compared to other modeling tools with advantages regarding user-friendliness, as
- the model definition is based on spreadsheets, therefore no programming skills are required for the entire modeling process,
- urban energy system models with any size can automatically conceptualized,
- visualization of complex results are automatically created in the form of system graphs, Pareto-fronts, energy amounts, capacity diagrams, and many more, as well as
- a set of standard (but still customizable) parameters are given, including detailed descriptions and references.
Furthermore, the SESMG comes with important modeling methods, enabling holistic modeling of spatially high resolution modeling of mixed-use multi energy systems, such as
- considering the multi-energy system (MES) approach
- applying multi-objective optimization by using the epsilon-constraint-method, as well as
- providing several methods for model-based reduction of computational requirements (run-time and RAM).
Quick Start
A detailed description of the installation process for Windows, MacOS and Linux can be found in the documentation (chapter installation).
SESMG Features & Releases
Examples
Examples are stored in a separate GIT-Repository: https://github.com/SESMG/SESMG-Examples
Project status
✓ Draft (alpha, beta) State
✓ Modeling and Optimization of holistic energy systems
✓ Automated modeling of urban energy systems
✓ Several result plotting oportunities
✓ Usable on Windows, MacOS and Linux
✘ More time to code other things ... wait ✓!
Detailed Documentation!
The documentation, which includes detailed instructions for installation and use, troubleshooting and much more, can be accessed via the following link:
https://spreadsheet-energy-system-model-generator.readthedocs.io/en/latest/
Questions?
Use the Discussions Section and let's chat!
Credits
Contact and Code of Conduct
Code of Conduct can be found here.
Contact information
Münster University of Applied Sciences
Contact via research group.
Acknowledgments
The Spreadsheet Energy System Model Generator was carried out within the research project R2Q "Resource Planing for Urban Districts". The project was funded by the Federal Ministry of Education and Research (BMBF) funding program RES:Z "Resource-Efficient Urban Districts". The funding measure is part of the flagship initiative "City of the Future" within the BMBF's framework programme "Research for Sustainable Development - FONA3". The contributors gratefully acknowledge the support of BMBF (grant number 033W102).
License
This project is published under GNU GPL-3.0 license, click here for more details.
Contributing
Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.
Detailed description of the contribution procedure as well as the projects coding standards can be found here.
Owner
- Name: SESMG
- Login: SESMG
- Kind: organization
- Location: Germany
- Website: www.fh.ms/esym
- Repositories: 2
- Profile: https://github.com/SESMG
Open source energy system modeling tool developed at Münster University of Applied Sciences
JOSS Publication
The Spreadsheet Energy System Model Generator (SESMG): A tool for the optimization of urban energy systems
Authors
Münster University of Applied Sciences, Department of Energy, Building Services and Environmental Engineering, Germany, Europa-Universität Flensburg, Department of Energy and Environmental Management, Germany
Münster University of Applied Sciences, Department of Energy, Building Services and Environmental Engineering, Germany
Münster University of Applied Sciences, Department of Energy, Building Services and Environmental Engineering, Germany
Münster University of Applied Sciences, Department of Energy, Building Services and Environmental Engineering, Germany
Münster University of Applied Sciences, Department of Energy, Building Services and Environmental Engineering, Germany
Editor
Tim Tröndle
Tags
Energy System Modeling Urban Energy System Optimization Multi-Energy SystemsCitation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Klemm
given-names: Christian
orcid: "https://orcid.org/0000-0003-0801-4178"
- family-names: Becker
given-names: Gregor
orcid: "https://orcid.org/0000-0001-8803-6873"
- family-names: Tockloth
given-names: Jan N.
orcid: "https://orcid.org/0000-0003-2582-1043"
- family-names: Budde
given-names: Janik
orcid: "https://orcid.org/0000-0002-1617-5900"
- family-names: Vennemann
given-names: Peter
orcid: "https://orcid.org/0000-0002-0767-5014"
contact:
- family-names: Klemm
given-names: Christian
orcid: "https://orcid.org/0000-0003-0801-4178"
doi: 10.5281/zenodo.8344791
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Klemm
given-names: Christian
orcid: "https://orcid.org/0000-0003-0801-4178"
- family-names: Becker
given-names: Gregor
orcid: "https://orcid.org/0000-0001-8803-6873"
- family-names: Tockloth
given-names: Jan N.
orcid: "https://orcid.org/0000-0003-2582-1043"
- family-names: Budde
given-names: Janik
orcid: "https://orcid.org/0000-0002-1617-5900"
- family-names: Vennemann
given-names: Peter
orcid: "https://orcid.org/0000-0002-0767-5014"
date-published: 2023-09-17
doi: 10.21105/joss.05519
issn: 2475-9066
issue: 89
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5519
title: "The Spreadsheet Energy System Model Generator (SESMG): A tool
for the optimization of urban energy systems"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05519"
volume: 8
title: "The Spreadsheet Energy System Model Generator (SESMG): A tool
for the optimization of urban energy systems"
GitHub Events
Total
- Create event: 4
- Release event: 2
- Issues event: 49
- Watch event: 3
- Delete event: 1
- Member event: 1
- Issue comment event: 14
- Push event: 79
- Pull request event: 10
- Fork event: 1
Last Year
- Create event: 4
- Release event: 2
- Issues event: 49
- Watch event: 3
- Delete event: 1
- Member event: 1
- Issue comment event: 14
- Push event: 79
- Pull request event: 10
- Fork event: 1
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Gregor Becker | 6****r | 1,908 |
| chrklemm | 4****m | 615 |
| Janik Budde | 6****7 | 340 |
| jtock | j****h@f****e | 296 |
| Christian Klemm | c****8@f****e | 154 |
| YannickWittor | 6****r | 99 |
| benblankenstein | 1****n | 31 |
| SESMG_bot | l****n@s****m | 16 |
| FranziKoert | 1****t | 9 |
| Janik Budde | j****2@f****e | 8 |
| marcograf1 | 1****1 | 7 |
| Becker | G****r | 5 |
| PascalKerkeling | 9****g | 4 |
| github-actions | g****s@g****m | 4 |
| DoVo | 1****i | 3 |
| Vinxenx | 9****x | 3 |
| github-actions | a****n@g****m | 3 |
| Danielnied | 1****d | 2 |
| TimSteinort | 1****t | 2 |
| Greene Lab Linter | c****e@u****u | 1 |
| L4rsG | 1****G | 1 |
| Philipp Sommer | 9****m | 1 |
| jan-frank | 8****k | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 142
- Total pull requests: 40
- Average time to close issues: 7 months
- Average time to close pull requests: 24 days
- Total issue authors: 16
- Total pull request authors: 10
- Average comments per issue: 1.31
- Average comments per pull request: 0.35
- Merged pull requests: 38
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 42
- Pull requests: 11
- Average time to close issues: 2 months
- Average time to close pull requests: 18 days
- Issue authors: 5
- Pull request authors: 3
- Average comments per issue: 0.19
- Average comments per pull request: 0.27
- Merged pull requests: 10
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jtock (36)
- GregorBecker (25)
- benblankenstein (22)
- FranziKoert (20)
- chrklemm (14)
- janik257 (10)
- DV-Bongingi (4)
- willu47 (2)
- detroitobi (1)
- marcograf1 (1)
- LeaSchwei (1)
- eikohi (1)
- nick-gorman (1)
- tschuering23 (1)
- rzurhold (1)
Pull Request Authors
- GregorBecker (12)
- Oquiro (7)
- Danielnied (5)
- jtock (5)
- chrklemm (5)
- DV-Bongingi (4)
- benblankenstein (3)
- TimSteinort (2)
- L4rsG (2)
- rzurhold (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 36
- Total maintainers: 3
proxy.golang.org: github.com/sesmg/sesmg
- Documentation: https://pkg.go.dev/github.com/sesmg/sesmg#section-documentation
- License: gpl-3.0
-
Latest release: v1.1.2
published 11 months ago
Rankings
proxy.golang.org: github.com/SESMG/SESMG
- Documentation: https://pkg.go.dev/github.com/SESMG/SESMG#section-documentation
- License: gpl-3.0
-
Latest release: v1.1.2
published 11 months ago
Rankings
pypi.org: sesmg
- Homepage: https://github.com/SESMG/SESMG
- Documentation: https://sesmg.readthedocs.io/
- License: GPL-3.0-only
-
Latest release: 0.5.0rc5
published over 2 years ago
Rankings
Maintainers (3)
Dependencies
- actions/checkout v2 composite
- actions/setup-python v1 composite
- samuelmeuli/lint-action v1 composite
- actions/checkout v3 composite
- actions/download-artifact v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v2 composite
- actions/upload-artifact v3 composite
- microsoft/setup-msbuild v1.1 composite
- svenstaro/upload-release-action v2 composite
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v2 composite
- actions/checkout v3 composite
- actions/download-artifact v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- actions/upload-artifact v2 composite
- microsoft/setup-msbuild v1.1 composite
- relekang/python-semantic-release master composite
- svenstaro/upload-release-action v2 composite
- actions/checkout v1 composite
- actions/setup-python v2 composite
- codecov/codecov-action v3.1.0 composite
- paambaati/codeclimate-action v3.0.0 composite
- sphinx >=1.3
- sphinx-rtd-theme *
- dash >=2.4.0
- dash_canvas >=0.1.0
- geocoder >=1.38.0
- graphviz >=0.20
- h5py ==3.6.0
- memory-profiler >=0.60.0
- oemof.solph ==0.4.5
- oemof.thermal >=0.0.5
- open_fred-cli >=0.0.1
- openpyxl >=3.0.0
- pandas <2.0.0
- pyside6 *
- pytest *
- richardsonpy >=0.2.0
- scikit-learn-extra >=0.2.0
- seaborn >=0.11.0
- shapely >=2.0.1
- streamlit <1.28.0
- streamlit-aggrid >=0.3.0
- sympy >=1.10.0
- xlsxwriter >=3.0.0