SpineOpt.jl

A highly adaptable modelling framework for multi-energy systems written in Julia.
https://github.com/spine-tools/SpineOpt.jl

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords

electricity energy energy-system-modelling energy-systems julia-language modelling-framework

Keywords from Contributors

anaconda miniconda simulation-model spine-toolbox optimisation energy-transition milp workflow-management data-management modelling-tool

Last synced: about 16 hours ago
JSON representation

Repository metadata

A highly adaptable modelling framework for multi-energy systems

README.md

SpineOpt.jl

Docs
codecov Join the chat at https://gitter.im/spine-tools/SpineOpt.jl

A Julia package containing a state-of-the-art energy system optimization model.

📢 Community and how to ask help 🚀

There are several ways to get help with SpineOpt.

  1. Monthly user meetings for Spine Toolbox and SpineOpt. There you can connect with other users, present problems and exchange experiences. New and old users equally welcome. The meetings are held first Tuesday of every month at 3pm CEST 📆 ics zip and can be joined here. For meeting updates, please checkout this discussion.
  2. Gitter (i.e. Matrix) chat service. You need to register but allows to ask quick questions and hopefullly get quick answers.
  3. Discussion forum (support section) can be used when you don't know how to get something done or you don't quite know why something isn't working. It's highly appreciated if other users can contribute by helping each other (developers are short on time).
  4. Issue tracker should be used only when there is a missing feature or something should work but it's not working. Update your tools and test with latest software before submitting an issue. In case of new feature, make sure there is no existing issue. Issues reporting bugs should provide sufficient information to enable locating and fixing the bug.

Getting started

We highly recommend you to go through the getting started chapter of the documentation.

The chapter explains in great detail the different ways to install SpineOpt. The prerequisites are also mentioned here.

The chapter also explains how to set up a minimal workflow to test your installation. This part also includes some explanations on what you see during the setup so you can already get a bit familiar with using SpineOpt.

If any issues arise during the first two steps, you can consult the trouble shooting section.

Once you have succesfully installed and verified the correct functioning of SpineOpt, you can start learning how to use SpineOpt. To that end you can visit the tutorials chapter of the documentation. The tutorials cover the different features of SpineOpt (the underlying files of the tutorials are part of our tests so these should always be up to date, though the text/images may lag behind some times).

Reporting Issues and Contributing

For contributing and instructions on reporting issues, see CONTRIBUTING.md

License

SpineOpt is licensed under GNU Lesser General Public License version 3.0 or later.

Citing SpineOpt

Please cite this article when referring to SpineOpt in scientific writing.

Ihlemann, M., Kouveliotis-Lysikatos, I., Huang, J., Dillon, J., O'Dwyer, C., Rasku, T., Marin, M., Poncelet, K., & Kiviluoma, J. (2022). SpineOpt: A flexible open-source energy system modelling framework. Energy Strategy Reviews, 43, [100902]. https://doi.org/10.1016/j.esr.2022.100902

Acknowledgements


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 3,373
Total Committers: 46
Avg Commits per committer: 73.326
Development Distribution Score (DDS): 0.754

Commits in past year: 168
Committers in past year: 21
Avg Commits per committer in past year: 8.0
Development Distribution Score (DDS) in past year: 0.732

Name Email Commits
Manuel Marin m****a@k****e 829
Manuel c****o@g****m 754
Rasku Topi t****u@v****i 473
u0122387 m****n@k****e 279
nnhjy j****g@o****m 178
Jody Dillon j****n@g****m 102
Jody Dillon j****n@e****e 97
Tars Verschelde t****e@k****e 84
manuelma m****n@e****e 82
T5600\Jody j****n@s****m 78
Huang, Jiangyi j****g@v****i 42
Maren Ihlemann 4****a@u****m 41
jkiviluo 4****o@u****m 39
Diego Alejandro Tejada Arango 1****a@u****m 37
tarskul 1****l@u****m 34
Kris Poncelet k****t@k****e 23
Steffen Kaminski s****i@k****e 22
Ni Wang n****g@t****l 22
Kristof Phillips K****s@k****e 18
Niina Helisto n****o@v****i 16
Lauren Clisby l****y@t****l 11
Erkka Rinne e****e@v****i 10
Lauren Clisby l****y@g****m 9
Ni Wang 1****n@u****m 9
Juha Kiviluoma j****a@v****i 8
Per Vennström p****m@v****i 8
github-actions[bot] 4****]@u****m 8
Tasku t****u@g****m 7
datejada d****o@t****l 7
Tasqu t****u@l****i 7
and 16 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 367
Total pull requests: 335
Average time to close issues: 12 months
Average time to close pull requests: 20 days
Total issue authors: 51
Total pull request authors: 20
Average comments per issue: 4.33
Average comments per pull request: 1.79
Merged pull request: 258
Bot issues: 0
Bot pull requests: 15

Past year issues: 68
Past year pull requests: 128
Past year average time to close issues: 25 days
Past year average time to close pull requests: 7 days
Past year issue authors: 19
Past year pull request authors: 15
Past year average comments per issue: 1.19
Past year average comments per pull request: 2.12
Past year merged pull request: 95
Past year bot issues: 0
Past year bot pull requests: 15

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/spine-tools/SpineOpt.jl

Top Issue Authors

  • datejada (54)
  • DillonJ (53)
  • manuelma (44)
  • spine-o-bot (34)
  • jkiviluo (24)
  • mihlema (22)
  • clizbe (18)
  • nnhjy (15)
  • Mastomaki (9)
  • gnawin (9)
  • nhniina (8)
  • tarskul (8)
  • aporrasc (5)
  • HaoyuFang0909 (5)
  • Alireza64z (4)

Top Pull Request Authors

  • manuelma (97)
  • datejada (61)
  • nnhjy (49)
  • gnawin (28)
  • tarskul (23)
  • github-actions[bot] (15)
  • clizbe (14)
  • nhniina (13)
  • ll-ara (6)
  • mihlema (6)
  • DillonJ (3)
  • Mastomaki (3)
  • Tasqu (3)
  • kkozersk (3)
  • abelsiqueira (2)

Top Issue Labels

  • Zone: model implementation (56)
  • stale (53)
  • Type: improvement (50)
  • Type: bug (32)
  • Type: new feature (24)
  • Zone: formulation (23)
  • Zone: documentation (22)
  • Zone: data & import (17)
  • good first issue (15)
  • model implementation (15)
  • Type: beautification (13)
  • Zone: output & feedback (12)
  • Type: performance enhancement (12)
  • bug (10)
  • Zone: integration & updates (10)
  • model formulation (9)
  • Type: epic (9)
  • specific data structure (8)
  • Type: feature (8)
  • help / question (8)
  • model documentation (8)
  • Zone: setup/admin (6)
  • discussion (6)
  • Zone: testing & validation (6)
  • archetype (6)
  • user-friendliness (6)
  • investments (5)
  • performance (4)
  • speed (4)
  • has attachment (4)

Top Pull Request Labels

  • model documentation (5)
  • Zone: formulation (2)
  • Type: improvement (2)
  • bug (1)
  • doing (1)
  • Type: new feature (1)

Package metadata

juliahub.com: SpineOpt

A highly adaptable modelling framework for multi-energy systems

  • Homepage: https://www.tools-for-energy-system-modelling.org/
  • Documentation: https://docs.juliahub.com/General/SpineOpt/stable/
  • Licenses: GPL-3.0
  • Latest release: 0.10.2 (published 6 months ago)
  • Last Synced: 2025-09-30T03:12:06.493Z (1 day ago)
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 10 Total
  • Rankings:
    • Downloads: 3.061%
    • Dependent repos count: 3.227%
    • Average: 7.532%
    • Dependent packages count: 16.308%

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-docdeploy latest composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest latest composite
  • julia-actions/setup-julia v1 composite

Score: 11.569305798406337