SpineOpt.jl

A highly adaptable modelling framework for multi-energy systems

https://github.com/spine-tools/SpineOpt.jl

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • 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
  • Academic publication links
  • Committers with academic emails
    1 of 34 committers (2.9%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.1%) to scientific vocabulary

Keywords

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

Keywords from Contributors

spine-toolbox simulation-model miniconda anaconda state-management energy-transition milp energy-system distributed energy-system-model
Last synced: 6 months ago · JSON representation

Repository

A highly adaptable modelling framework for multi-energy systems

Basic Info
Statistics
  • Stars: 72
  • Watchers: 7
  • Forks: 20
  • Open Issues: 157
  • Releases: 12
Topics
electricity energy energy-system-modelling energy-systems julia-language modelling-framework
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License

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.

:loudspeaker: Community and how to ask help :rocket:

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 :calendar: 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

EU emblem This work has been partially supported by EU project Mopo (2023-2026), which has received funding from European Climate, Infrastructure and Environment Executive Agency under the European Union’s HORIZON Research and Innovation Actions under grant agreement N°101095998.
EU emblem This work has been partially supported by EU project Spine (2017-2021), which has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 774629.

Owner

  • Name: Spine tools
  • Login: spine-tools
  • Kind: organization
  • Email: spine_info@vtt.fi

Open source modelling tools

GitHub Events

Total
  • Fork event: 4
  • Create event: 51
  • Commit comment event: 21
  • Release event: 6
  • Issues event: 77
  • Watch event: 13
  • Delete event: 50
  • Member event: 3
  • Issue comment event: 253
  • Push event: 329
  • Pull request review comment event: 20
  • Pull request review event: 36
  • Pull request event: 89
Last Year
  • Fork event: 4
  • Create event: 51
  • Commit comment event: 21
  • Release event: 6
  • Issues event: 77
  • Watch event: 13
  • Delete event: 50
  • Member event: 3
  • Issue comment event: 253
  • Push event: 329
  • Pull request review comment event: 20
  • Pull request review event: 36
  • Pull request event: 89

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 3,350
  • Total Committers: 34
  • Avg Commits per committer: 98.529
  • Development Distribution Score (DDS): 0.753
Past Year
  • Commits: 235
  • Committers: 15
  • Avg Commits per committer: 15.667
  • Development Distribution Score (DDS): 0.672
Top Committers
Name Email Commits
Manuel Marin m****a@k****e 829
Manuel c****o@g****m 829
Rasku Topi t****u@v****i 480
u0122387 m****n@k****e 279
Jody Dillon j****n@g****m 199
nnhjy j****g@o****m 178
T5600\Jody j****n@s****m 78
Tars Verschelde t****e@k****e 74
jkiviluo 4****o 47
Diego Alejandro Tejada Arango 1****a 44
Huang, Jiangyi j****g@v****i 42
Maren Ihlemann 4****a 41
tarskul 1****l 35
Ni Wang n****g@t****l 31
Kris Poncelet k****t@k****e 23
Steffen Kaminski s****i@k****e 22
Niina Helisto n****o@v****i 20
Lauren Clisby l****y@t****l 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 6
JustinasJas 1****s 5
Troy Bober t****r@g****m 3
ll-ara l****3@g****m 2
Abel Soares Siqueira a****a@g****m 2
Antti Soininen a****n@v****i 1
and 4 more...
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 366
  • Total pull requests: 329
  • 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.34
  • Average comments per pull request: 1.74
  • Merged pull requests: 256
  • Bot issues: 0
  • Bot pull requests: 15
Past Year
  • Issues: 73
  • Pull requests: 142
  • Average time to close issues: 27 days
  • Average time to close pull requests: 7 days
  • Issue authors: 19
  • Pull request authors: 15
  • Average comments per issue: 1.1
  • Average comments per pull request: 1.91
  • Merged pull requests: 107
  • Bot issues: 0
  • Bot pull requests: 15
Top Authors
Issue Authors
  • datejada (54)
  • DillonJ (53)
  • manuelma (42)
  • spine-o-bot (34)
  • jkiviluo (24)
  • mihlema (22)
  • clizbe (18)
  • nnhjy (15)
  • Mastomaki (9)
  • nhniina (9)
  • gnawin (9)
  • tarskul (8)
  • aporrasc (5)
  • HaoyuFang0909 (5)
  • Alireza64z (4)
Pull Request Authors
  • manuelma (92)
  • 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)
  • abelsiqueira (2)
  • JustinasJas (2)
Top Labels
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)
Pull Request Labels
model documentation (5) Zone: formulation (2) Type: improvement (2) bug (1) doing (1)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 9 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
juliahub.com: SpineOpt

A highly adaptable modelling framework for multi-energy systems

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 9 Total
Rankings
Downloads: 3.1%
Dependent repos count: 3.2%
Average: 7.5%
Dependent packages count: 16.3%
Last synced: 6 months ago

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