SESMG

An energy system model generator with the focus on the optimization of urban energy systems.
https://github.com/sesmg/sesmg

Category: Energy Systems
Sub Category: Renewable Energy Integration

Keywords from Contributors

routing feature-engine batteries parallel profiles trace actions changed-file assessment

Last synced: about 8 hours ago
JSON representation

Repository metadata

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).

Host: GitHub
URL: https://github.com/sesmg/sesmg
Owner: SESMG
License: gpl-3.0
Created: 2020-08-07T10:14:16.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2025-04-29T13:23:47.000Z (1 day ago)
Last Synced: 2025-04-29T14:11:27.691Z (1 day ago)
Language: Python
Size: 320 MB
Stars: 23
Watchers: 4
Forks: 19
Open Issues: 54
Releases: 20
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

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).

workflow_graph_SESMG

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.

Citation (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"

Owner metadata

Name: SESMG
Login: SESMG
Email:
Kind: organization
Description: Open source energy system modeling tool developed at Münster University of Applied Sciences
Website: www.fh.ms/esym
Location: Germany
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/122264954?v=4
Repositories: 2
Last ynced at: 2023-03-07T13:49:48.079Z
Profile URL: https://github.com/SESMG

GitHub Events

Total

Create event: 4
Release event: 2
Issues event: 37
Watch event: 3
Delete event: 1
Issue comment event: 12
Push event: 45
Pull request event: 6
Fork event: 1

Last Year

Create event: 4
Release event: 2
Issues event: 37
Watch event: 3
Delete event: 1
Issue comment event: 12
Push event: 45
Pull request event: 6
Fork event: 1

Committers metadata

Last synced: 8 days ago

Total Commits: 3,513
Total Committers: 23
Avg Commits per committer: 152.739
Development Distribution Score (DDS): 0.457

Commits in past year: 111
Committers in past year: 9
Avg Commits per committer in past year: 12.333
Development Distribution Score (DDS) in past year: 0.613

Name	Email	Commits
Gregor Becker	6****r	1908
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:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 151
Total pull requests: 33
Average time to close issues: 7 months
Average time to close pull requests: 26 days
Total issue authors: 15
Total pull request authors: 10
Average comments per issue: 1.25
Average comments per pull request: 0.39
Merged pull request: 32
Bot issues: 0
Bot pull requests: 0

Past year issues: 53
Past year pull requests: 8
Past year average time to close issues: 3 months
Past year average time to close pull requests: 17 days
Past year issue authors: 4
Past year pull request authors: 6
Past year average comments per issue: 0.19
Past year average comments per pull request: 0.88
Past year merged pull request: 8
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/sesmg/sesmg

Top Issue Authors

jtock (35)
benblankenstein (30)
GregorBecker (26)
FranziKoert (22)
chrklemm (14)
janik257 (10)
DV-Bongingi (4)
nick-gorman (2)
willu47 (2)
marcograf1 (1)
LeaSchwei (1)
eikohi (1)
tschuering23 (1)
rzurhold (1)
TimSteinort (1)

Top Pull Request Authors

GregorBecker (10)
chrklemm (5)
DV-Bongingi (4)
benblankenstein (3)
Danielnied (3)
jtock (2)
TimSteinort (2)
Oquiro (2)
L4rsG (1)
rzurhold (1)

Top Issue Labels

bug (44)
wish list (43)
new feature (35)
JOSS (33)
GUI (26)
documentation (20)
lecture (9)
done in dev (8)
help wanted (5)
installation (4)
question (4)
enhancement (3)

Top Pull Request Labels

Package metadata

Total packages: 1
Total downloads: unknown
Total dependent packages: 0
Total dependent repositories: 0
Total versions: 6
Total maintainers: 3

pypi.org: sesmg

Homepage: https://github.com/SESMG/SESMG
Documentation: https://sesmg.readthedocs.io/
Licenses: GPL-3.0-only
Latest release: 0.5.0rc5 (published almost 2 years ago)
Last Synced: 2024-12-07T18:22:57.416Z (5 months ago)
Versions: 6
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 7.246%
- Average: 24.262%
- Dependent repos count: 41.279%
Maintainers (3)

Dependencies

.github/workflows/black.yml actions

actions/checkout v2 composite
actions/setup-python v1 composite
samuelmeuli/lint-action v1 composite

.github/workflows/build.yml actions

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
svenstaro/upload-release-action v2 composite

.github/workflows/draft-pdf.yml actions

actions/checkout v2 composite
actions/upload-artifact v1 composite
openjournals/openjournals-draft-action master composite

.github/workflows/semantic_versioning.yml actions

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

.github/workflows/test_coverage.yml actions

actions/checkout v1 composite
actions/setup-python v2 composite
codecov/codecov-action v3.1.0 composite
paambaati/codeclimate-action v3.0.0 composite

docs/requirements.txt pypi

sphinx >=1.3
sphinx-rtd-theme *

pyproject.toml pypi

requirements.txt pypi

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

setup.py pypi

Score: 8.577911926450943

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology