Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spine-tools/spineopt.jl
A highly adaptable modelling framework for multi-energy systems
https://github.com/spine-tools/spineopt.jl
electricity energy energy-system-modelling energy-systems julia-language modelling-framework
Last synced: 2 days ago
JSON representation
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 (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:43:02.000Z (about 2 months ago)
- Last Synced: 2024-10-29T10:56:29.914Z (about 2 months 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: 110 MB
- Stars: 56
- Watchers: 9
- Forks: 13
- Open Issues: 130
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## SpineOpt.jl
[](https://spine-tools.github.io/SpineOpt.jl/latest/index.html)
[](https://codecov.io/gh/spine-tools/SpineOpt.jl) [](https://gitter.im/spine-tools/SpineOpt.jl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A Julia package containing a state-of-the-art energy system optimization model.
### :loudspeaker: Community and how to ask help :rocket:
There are four main 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](https://github.com/spine-tools/SpineOpt.jl/blob/master/SpineTools_user_meeting.ics) and can be joined [here](https://teams.microsoft.com/l/meetup-join/19%3ameeting_ZDBkZjBhNmEtMGFmZi00ZDllLWE4ZmQtMWJhMWZjYjUyNDUy%40thread.v2/0?context=%7b%22Tid%22%3a%223973589b-9e40-4eb5-800e-b0b6383d1621%22%2c%22Oid%22%3a%224c379655-31a5-4c3e-b6d6-b61817a44e14%22%7d). For meeting updates, please checkout [this discussion](https://github.com/spine-tools/SpineOpt.jl/discussions/849).
2. [Gitter](https://app.gitter.im/#/room/#spine-tools_community:gitter.im) (i.e. Matrix) chat service. You need to register but allows to ask quick questions and hopefullly get quick answers.
3. [Discussion forum](https://github.com/spine-tools/SpineOpt.jl/discussions/categories/support) (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](https://github.com/spine-tools/SpineOpt.jl/issues) 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](https://spine-tools.github.io/SpineOpt.jl/latest/getting_started/installation/) SpineOpt. The prerequisites are also mentioned here.
The chapter also explains how to set up a minimal [workflow](https://spine-tools.github.io/SpineOpt.jl/latest/getting_started/recommended_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](https://spine-tools.github.io/SpineOpt.jl/latest/getting_started/troubleshooting/) 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](CONTRIBUTING.md)
### License
SpineOpt is licensed under GNU Lesser General Public License version 3.0 or later.
### Citing SpineOpt
Please cite [this article](https://doi.org/10.1016/j.esr.2022.100902) 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
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.
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.