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 stay in touch with the community and to get help with SpineOpt.

1. To keep up to date with official announcements, subscribe to our mail list.
2. To keep up to date with informal announcements, check out this discussion
3. Typically, we organize a monthly meeting to connect with users, identify problems and exchange experiences. However, this year we present you a yearlong series of events and webinars to show of the fruits of our labour during the mopo project. The program of which can be found on the spine tools project page.
4. Gitter (i.e. Matrix) chat service. You need to register but allows to ask quick questions and hopefullly get quick answers.
5. 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).
6. 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 part 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

<center> <table width=500px frame="none"> <tr> <td valign="middle" width=100px> <img src=docs/src/figs/eu-emblem-low-res.jpg alt="EU emblem" width=100%></td> <td valign="middle">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.</td> <tr> <td valign="middle" width=100px> <img src=docs/src/figs/eu-emblem-low-res.jpg alt="EU emblem" width=100%></td> <td valign="middle">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.</td> </table> </center>