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
simulation-model anaconda miniconda spine-toolbox optimisation data-management workflow-management energy-transition simulations charts
Last synced: about 1 hour ago
JSON representation
Repository metadata
A highly adaptable modelling framework for multi-energy systems
- Host: GitHub
- URL: https://github.com/spine-tools/SpineOpt.jl
- Owner: spine-tools
- License: gpl-3.0
- Created: 2018-10-08T09:22:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-24T15:17:26.000Z (3 days ago)
- Last Synced: 2025-04-25T14:44:03.957Z (2 days ago)
- Topics: electricity, energy, energy-system-modelling, energy-systems, julia-language, modelling-framework
- Language: Julia
- Homepage: https://www.tools-for-energy-system-modelling.org/
- Size: 120 MB
- Stars: 67
- Watchers: 7
- Forks: 17
- Open Issues: 139
- Releases: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
README.md
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.
- 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.
- Gitter (i.e. Matrix) chat service. You need to register but allows to ask quick questions and hopefullly get quick answers.
- 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).
- 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
- Name: Spine tools
- Login: spine-tools
- Email: [email protected]
- Kind: organization
- Description: Open source modelling tools
- Website: http://www.spine-model.org/
- Location:
- Twitter: Spine_Project
- Company:
- Icon url: https://avatars.githubusercontent.com/u/42807090?v=4
- Repositories: 29
- Last ynced at: 2023-03-10T15:15:46.390Z
- Profile URL: https://github.com/spine-tools
GitHub Events
Total
- Fork event: 3
- Create event: 43
- Commit comment event: 21
- Release event: 6
- Issues event: 51
- Watch event: 11
- Delete event: 40
- Member event: 3
- Issue comment event: 146
- Push event: 235
- Pull request review comment event: 11
- Pull request review event: 21
- Pull request event: 61
Last Year
- Fork event: 3
- Create event: 43
- Commit comment event: 21
- Release event: 6
- Issues event: 51
- Watch event: 11
- Delete event: 40
- Member event: 3
- Issue comment event: 146
- Push event: 235
- Pull request review comment event: 11
- Pull request review event: 21
- Pull request event: 61
Committers metadata
Last synced: 6 days ago
Total Commits: 3,332
Total Committers: 33
Avg Commits per committer: 100.97
Development Distribution Score (DDS): 0.751
Commits in past year: 388
Committers in past year: 15
Avg Commits per committer in past year: 25.867
Development Distribution Score (DDS) in past year: 0.528
| Name | Commits | |
|---|---|---|
| Manuel Marin | m****a@k****e | 829 |
| Manuel | c****o@g****m | 829 |
| Rasku Topi | t****u@v****i | 479 |
| u0122387 | m****n@k****e | 279 |
| Jody Dillon | j****n@g****m | 199 |
| nnhjy | j****g@o****m | 172 |
| T5600\Jody | j****n@s****m | 78 |
| Tars Verschelde | t****e@k****e | 74 |
| jkiviluo | 4****o | 47 |
| Huang, Jiangyi | j****g@v****i | 42 |
| Maren Ihlemann | 4****a | 41 |
| Diego Alejandro Tejada Arango | 1****a | 37 |
| tarskul | 1****l | 34 |
| Ni Wang | n****g@t****l | 31 |
| Kris Poncelet | k****t@k****e | 23 |
| Steffen Kaminski | s****i@k****e | 22 |
| Lauren Clisby | l****y@t****l | 20 |
| Niina Helisto | n****o@v****i | 20 |
| Kristof Phillips | K****s@k****e | 18 |
| Erkka Rinne | e****e@v****i | 10 |
| Per Vennström | p****m@v****i | 8 |
| github-actions[bot] | 4****] | 7 |
| Tasku | t****u@g****m | 7 |
| Tim | t****s@k****e | 6 |
| Jussi Ikaheimo | j****o@v****i | 5 |
| JustinasJas | 1****s | 5 |
| Troy Bober | t****r@g****m | 3 |
| Abel Soares Siqueira | a****a@g****m | 2 |
| Antti Soininen | a****n@v****i | 1 |
| Lissy Langer | 5****r | 1 |
| and 3 more... | ||
Committer domains:
- vtt.fi: 8
- kuleuven.be: 5
- tno.nl: 2
- gitter.im: 1
- kulueven.be: 1
- smartwires.com: 1
- kth.se: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 374
Total pull requests: 162
Average time to close issues: 12 months
Average time to close pull requests: 22 days
Total issue authors: 44
Total pull request authors: 16
Average comments per issue: 4.87
Average comments per pull request: 2.27
Merged pull request: 133
Bot issues: 0
Bot pull requests: 8
Past year issues: 91
Past year pull requests: 113
Past year average time to close issues: 30 days
Past year average time to close pull requests: 12 days
Past year issue authors: 19
Past year pull request authors: 13
Past year average comments per issue: 3.07
Past year average comments per pull request: 1.84
Past year merged pull request: 97
Past year bot issues: 0
Past year bot pull requests: 8
Top Issue Authors
- DillonJ (50)
- datejada (49)
- manuelma (45)
- spine-o-bot (34)
- clizbe (28)
- jkiviluo (25)
- mihlema (23)
- nnhjy (20)
- nhniina (11)
- gnawin (10)
- Mastomaki (9)
- tarskul (8)
- HaoyuFang0909 (5)
- hannesfelipe (5)
- Tasqu (4)
Top Pull Request Authors
- manuelma (37)
- datejada (29)
- gnawin (21)
- nnhjy (21)
- tarskul (18)
- nhniina (9)
- github-actions[bot] (8)
- clizbe (6)
- mihlema (4)
- gitter-badger (2)
- Tasqu (2)
- DillonJ (1)
- Mastomaki (1)
- ghost (1)
- soininen (1)
Top Issue Labels
- Type: improvement (75)
- Zone: model implementation (70)
- stale (53)
- Type: bug (44)
- Type: new feature (35)
- Zone: documentation (32)
- Zone: formulation (31)
- Type: epic (23)
- Zone: data & import (20)
- Zone: output & feedback (20)
- Type: beautification (17)
- model implementation (16)
- good first issue (15)
- Type: performance enhancement (15)
- Zone: testing & validation (14)
- Zone: integration & updates (13)
- help / question (13)
- bug (11)
- model formulation (10)
- model documentation (8)
- specific data structure (8)
- Type: feature (7)
- discussion (6)
- archetype (6)
- user-friendliness (5)
- investments (5)
- speed (4)
- Zone: setup/admin (4)
- performance (4)
- has attachment (4)
Top Pull Request Labels
- model documentation (5)
- bug (1)
- doing (1)
- Zone: formulation (1)
- Type: improvement (1)
Package metadata
- Total packages: 1
-
Total downloads:
- julia: 30 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 6
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 18 days ago)
- Last Synced: 2025-04-26T14:41:22.594Z (1 day ago)
- Versions: 6
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 30 Total
-
Rankings:
- Downloads: 3.061%
- Dependent repos count: 3.227%
- Average: 7.532%
- Dependent packages count: 16.308%
Dependencies
- 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: 12.225581111918217