# EnergyScope Library
## Overview
This library is part of the EnergyScope project, designed for energy system modeling and analysis. It includes the following core functionalities:
1. **Model Setup and Documentation**: A set of energy models tailored to specific scenarios, along with comprehensive documentation.
2. **Pre-Calculation**: Tools for preparing and processing input data.
3. **Model Solving**: Optimization tools for running simulations based on the pre-calculated input.
4. **KPI Calculation and Plotting**: Tools to compute Key Performance Indicators (KPIs) and visualize results.
For more detailed information, please refer to the full [documentation](https://library.energyscope.ch).
------------------------------------------------------------------------
## Installation
For detailed installation instructions, please refer to the [Getting Started Guide](https://library.energyscope.ch).
To install the EnergyScope library, use the following command:
``` bash
pip install energyscope
```
Alternatively, you may clone the repository and install the package manually:
``` bash
git clone <repo-url>
cd <project-directory>
pip install .
```
------------------------------------------------------------------------
## Acknowledging Authorship
In the academic spirit of collaboration, please acknowledge the authorship of this library in any scientific dissemination. Cite the EnergyScope project as follows:
- For reference to the origins of the EnergyScope project or the first online version, cite \[2\].
- For the EnergyScope MILP framework, cite \[2\].
- For Typical Day version, cite \[3\].
- For the carbon flows model, cite \[4\]
- For the mobility framework, cite \[5\] & \[6\]
- For the transition pathway models, cite \[7\] (Belgium) and \[8\] (Switzerland)
- For the multicell model, cite \[9\]
- For the non-energy demand integration, cite \[10\]
- For the infrastructure model, cite \[11\]
- For the decentralization model, cite \[12\]
- For the LCA model, cite \[13\]
The **main contributors** includes:
- [Stefano Moret](mailto:morets@ethz.ch) (EnergyScope Creator)
- [Gauthier Limpens](mailto:gauthier.limpens@uclouvain.be) (EnergyScope Improver)
- [Jonas Schnidrig](mailto:jonas.schnidrig@hevs.ch) (Library, Plotting, Documentation, Development)
- [Xavier Rixhon](mailto:xavier.rixhon@uclouvain.be) (EnergyScope Developer, Documentation)
- [Arthur Chuat](mailto:arthur.chuat@epfl.ch) (Library, Plotting, Documentation, Development)
- [Cyrille Platteau](mailto:cyrille.platteau@epfl.ch) (IT)
Refer to the [Releases file](./Releases.rst) for additional contributors and acknowledgments.
------------------------------------------------------------------------
## Documentation
Full documentation, including a model overview, releases, publications, model formulation, data sources, and exercises, can be found at [library.energyscope.ch](https://library.energyscope.ch).
------------------------------------------------------------------------
## Bug Reporting and Support
- For bug reports or feature requests, please use the GitLab issue tracker.
- For general inquiries or simple questions, join our [Slack community](https://join.slack.com/t/energyscopecommunity/shared_invite/zt-2qvzddo04-FaSMPFpiE88xbXEgpnSmdA).
------------------------------------------------------------------------
## Release Process
To release a new version of the library, follow these steps:
1. Ensure that the pipeline on the `main` branch is successful.
2. Update the version of the library in the file `src/energyscope/__init__.py` on the `main` branch:
- For a bug fix, increase the digit on the right (e.g., from `0.4.1` to `0.4.2`).
- For new features, increase the middle digit and reset the bug fix digit (e.g., from `0.4.1` to `0.5.0`).
- For a major release or breaking changes, increase the digit on the left and reset the others (e.g., from `0.4.1` to `1.0.0`).
3. [Create a tag](https://www.gitlab.com/energyscope/energyscope/-/tags) `vx.y.z` from the `main` branch:
- The tag should be a `v` followed by the version `x.y.z`, matching the version specified earlier.
- Example tags: `v0.4.2`, `v0.5.0`, or `v1.0.0`, based on the previous versioning examples.
------------------------------------------------------------------------
## References
\[1\] V. Codina Gironès, S. Moret, F. Maréchal, D. Favrat
(2015). Strategic energy planning for large-scale energy systems: A
modelling framework to aid decision-making. Energy, 90(PA1), 173–186. <https://doi.org/10.1016/j.energy.2015.06.008>
\[2\] S. Moret, M. Bierlaire, F. Maréchal (2016). Strategic
Energy Planning under Uncertainty: a Mixed-Integer Linear Programming
Modeling Framework for Large-Scale Energy Systems. <https://doi.org/10.1016/B978-0-444-63428-3.50321-0>
\[3\] G. Limpens, S . Moret, H. Jeanmart, F. Maréchal (2019). EnergyScope TD:
a novel open-source model for regional energy systems and its
application to the case of Switzerland. <https://doi.org/10.1016/j.apenergy.2019.113729>
\[4\] X. Li, T. Damartzis, Z. Stadler, S. Moeret, B. Meier, M. Friedli, F. Maréchal (2020). Decarbonization in Complex Energy Systems: A Study on the Feasibility of Carbon Neutrality for Switzerland in 2050. Front. Energy Res. Volume 8, <https://doi.org/10.3389/fenrg.2020.549615>
\[5\] J. Schnidrig, T.-V. Nguyen, X. Li, F. Maréchal (2021). A modelling framework for assessing the impact of green mobility technologies on energy systems. ECOS <https://infoscience.epfl.ch/entities/publication/d521fe41-b873-46da-b4b3-8d31938d3df5>
\[6\] T.-V. Nguyen, J. Schnidrig, An analysis of the impacts of green mobility strategies and technologies on different European energy system F. Maréchal (2021). https://infoscience.epfl.ch/entities/publication/bf57ffc4-51fb-4f31-822c-ee51ceb79e39
\[7\] G. Limpens (2021). Generating energy transition
pathways: application to Belgium. PhD thesis Université Catholique de
Louvain. <http://hdl.handle.net/2078.1/249196>
\[8\] X. Li, J. Schnidrig, M. Souttre, F. Maréchal (2022). A dynamic methodology for analyzing energy transitional pathways. IEEE PESGM <https://doi.org/10.1109/PESGM48719.2022.9916902>
\[9\] J. Schnidrig, X. Li, A. Slaymaker, T.-V. Nguyen, F. Maréchal (2022). Regionalisation in high share renewable energy system modelling. IEEE PESGM <https://doi.org/10.1109/PESGM48719.2022.9917062>
\[10\] X. Rixhon, D. Tonelli, M. Colla, K. Verleysen, G. Limpens, H. Jeanmart, F. Contino (2022). Integration of non-energy among the end-use demands of bottom-up whole-energy system models. Front. Energy Res. Volume 10. <https://doi.org/10.3389/fenrg.2022.904777>
\[11\] J. Schnidrig, R. Cherkaoui, Y. Calisesi, M. Margni, F. Maréchal (2023). On the role of energy infrastructure in the energy transition. Case study of an energy independent and CO2 neutral energy system for Switzerland. Front. Energy Res. Volume 11, <https://doi.org/10.3389/fenrg.2023.1164813>
\[12\] J. Schnidrig*, M. Souttre*, A. Chuat*, F. Maréchal, M. Margni (2023). Between Green Hills and Green Bills: Unveiling the Green Shades of Sustainability and Burden Shifting through Multi-Objective Optimization in Swiss Energy System Planning, JEMA, <https://arxiv.org/abs/2402.12973>
\[13\] J. Schnidrig, A. Chuat, C. Terrier, F. Maréchal, M. Margni (2024). Power to the People: On the Role of Districts in Decentralized Energy Systems. Energies, Vol 17, Issue 7. <https://www.mdpi.com/1996-1073/17/7/1718#>
Raw data
{
"_id": null,
"home_page": null,
"name": "energyscope",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "IPESE IT <it.ipese@epfl.ch>",
"keywords": "analysis, energy, energy system, modeling",
"author": null,
"author_email": "Jonas Schnidrig <jonas.schnidrig@hevs.ch>, Arthur Chuat <arthur.chuat@epfl.ch>, Cyrille Platteau <cyrille.platteau@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/e0/f0/c184c45f391460253d60978478e01b8a6a14017a58c166f5962a3c798423/energyscope-1.0.0.tar.gz",
"platform": null,
"description": "# EnergyScope Library\n\n## Overview\n\nThis library is part of the EnergyScope project, designed for energy system modeling and analysis. It includes the following core functionalities:\n\n1. **Model Setup and Documentation**: A set of energy models tailored to specific scenarios, along with comprehensive documentation.\n2. **Pre-Calculation**: Tools for preparing and processing input data.\n3. **Model Solving**: Optimization tools for running simulations based on the pre-calculated input.\n4. **KPI Calculation and Plotting**: Tools to compute Key Performance Indicators (KPIs) and visualize results.\n\nFor more detailed information, please refer to the full [documentation](https://library.energyscope.ch).\n\n------------------------------------------------------------------------\n\n## Installation\n\nFor detailed installation instructions, please refer to the [Getting Started Guide](https://library.energyscope.ch).\n\nTo install the EnergyScope library, use the following command:\n\n``` bash\npip install energyscope\n```\n\nAlternatively, you may clone the repository and install the package manually:\n\n``` bash\ngit clone <repo-url>\ncd <project-directory>\npip install .\n```\n\n------------------------------------------------------------------------\n\n## Acknowledging Authorship\n\nIn the academic spirit of collaboration, please acknowledge the authorship of this library in any scientific dissemination. Cite the EnergyScope project as follows:\n\n- For reference to the origins of the EnergyScope project or the first online version, cite \\[2\\].\n- For the EnergyScope MILP framework, cite \\[2\\].\n- For Typical Day version, cite \\[3\\].\n- For the carbon flows model, cite \\[4\\]\n- For the mobility framework, cite \\[5\\] & \\[6\\]\n- For the transition pathway models, cite \\[7\\] (Belgium) and \\[8\\] (Switzerland)\n- For the multicell model, cite \\[9\\]\n- For the non-energy demand integration, cite \\[10\\]\n- For the infrastructure model, cite \\[11\\]\n- For the decentralization model, cite \\[12\\]\n- For the LCA model, cite \\[13\\]\n\nThe **main contributors** includes:\n\n- [Stefano Moret](mailto:morets@ethz.ch) (EnergyScope Creator)\n- [Gauthier Limpens](mailto:gauthier.limpens@uclouvain.be) (EnergyScope Improver)\n- [Jonas Schnidrig](mailto:jonas.schnidrig@hevs.ch) (Library, Plotting, Documentation, Development)\n- [Xavier Rixhon](mailto:xavier.rixhon@uclouvain.be) (EnergyScope Developer, Documentation)\n- [Arthur Chuat](mailto:arthur.chuat@epfl.ch) (Library, Plotting, Documentation, Development)\n- [Cyrille Platteau](mailto:cyrille.platteau@epfl.ch) (IT)\n\nRefer to the [Releases file](./Releases.rst) for additional contributors and acknowledgments.\n\n------------------------------------------------------------------------\n\n## Documentation\n\nFull documentation, including a model overview, releases, publications, model formulation, data sources, and exercises, can be found at [library.energyscope.ch](https://library.energyscope.ch).\n\n------------------------------------------------------------------------\n\n## Bug Reporting and Support\n\n- For bug reports or feature requests, please use the GitLab issue tracker.\n- For general inquiries or simple questions, join our [Slack community](https://join.slack.com/t/energyscopecommunity/shared_invite/zt-2qvzddo04-FaSMPFpiE88xbXEgpnSmdA).\n\n------------------------------------------------------------------------\n\n## Release Process\n\nTo release a new version of the library, follow these steps:\n\n1. Ensure that the pipeline on the `main` branch is successful.\n2. Update the version of the library in the file `src/energyscope/__init__.py` on the `main` branch:\n - For a bug fix, increase the digit on the right (e.g., from `0.4.1` to `0.4.2`).\n - For new features, increase the middle digit and reset the bug fix digit (e.g., from `0.4.1` to `0.5.0`).\n - For a major release or breaking changes, increase the digit on the left and reset the others (e.g., from `0.4.1` to `1.0.0`).\n3. [Create a tag](https://www.gitlab.com/energyscope/energyscope/-/tags) `vx.y.z` from the `main` branch:\n - The tag should be a `v` followed by the version `x.y.z`, matching the version specified earlier.\n - Example tags: `v0.4.2`, `v0.5.0`, or `v1.0.0`, based on the previous versioning examples.\n\n------------------------------------------------------------------------\n\n## References\n\n\\[1\\] V. Codina Giron\u00e8s, S. Moret, F. Mar\u00e9chal, D. Favrat\n(2015). Strategic energy planning for large-scale energy systems: A\nmodelling framework to aid decision-making. Energy, 90(PA1), 173\u2013186. <https://doi.org/10.1016/j.energy.2015.06.008>\n\n\\[2\\] S. Moret, M. Bierlaire, F. Mar\u00e9chal (2016). Strategic\nEnergy Planning under Uncertainty: a Mixed-Integer Linear Programming\nModeling Framework for Large-Scale Energy Systems. <https://doi.org/10.1016/B978-0-444-63428-3.50321-0>\n\n\\[3\\] G. Limpens, S . Moret, H. Jeanmart, F. Mar\u00e9chal (2019). EnergyScope TD:\na novel open-source model for regional energy systems and its\napplication to the case of Switzerland. <https://doi.org/10.1016/j.apenergy.2019.113729>\n\n\\[4\\] X. Li, T. Damartzis, Z. Stadler, S. Moeret, B. Meier, M. Friedli, F. Mar\u00e9chal (2020). Decarbonization in Complex Energy Systems: A Study on the Feasibility of Carbon Neutrality for Switzerland in 2050. Front. Energy Res. Volume 8, <https://doi.org/10.3389/fenrg.2020.549615>\n\n\\[5\\] J. Schnidrig, T.-V. Nguyen, X. Li, F. Mar\u00e9chal (2021). A modelling framework for assessing the impact of green mobility technologies on energy systems. ECOS <https://infoscience.epfl.ch/entities/publication/d521fe41-b873-46da-b4b3-8d31938d3df5>\n\n\\[6\\] T.-V. Nguyen, J. Schnidrig, An analysis of the impacts of green mobility strategies and technologies on different European energy system F. Mar\u00e9chal (2021). https://infoscience.epfl.ch/entities/publication/bf57ffc4-51fb-4f31-822c-ee51ceb79e39\n\n\\[7\\] G. Limpens (2021). Generating energy transition\npathways: application to Belgium. PhD thesis Universit\u00e9 Catholique de\nLouvain. <http://hdl.handle.net/2078.1/249196>\n\n\\[8\\] X. Li, J. Schnidrig, M. Souttre, F. Mar\u00e9chal (2022). A dynamic methodology for analyzing energy transitional pathways. IEEE PESGM <https://doi.org/10.1109/PESGM48719.2022.9916902>\n\n\\[9\\] J. Schnidrig, X. Li, A. Slaymaker, T.-V. Nguyen, F. Mar\u00e9chal (2022). Regionalisation in high share renewable energy system modelling. IEEE PESGM <https://doi.org/10.1109/PESGM48719.2022.9917062>\n\n\\[10\\] X. Rixhon, D. Tonelli, M. Colla, K. Verleysen, G. Limpens, H. Jeanmart, F. Contino (2022). Integration of non-energy among the end-use demands of bottom-up whole-energy system models. Front. Energy Res. Volume 10. <https://doi.org/10.3389/fenrg.2022.904777>\n\n\\[11\\] J. Schnidrig, R. Cherkaoui, Y. Calisesi, M. Margni, F. Mar\u00e9chal (2023). On the role of energy infrastructure in the energy transition. Case study of an energy independent and CO2 neutral energy system for Switzerland. Front. Energy Res. Volume 11, <https://doi.org/10.3389/fenrg.2023.1164813>\n\n\\[12\\] J. Schnidrig*, M. Souttre*, A. Chuat*, F. Mar\u00e9chal, M. Margni (2023). Between Green Hills and Green Bills: Unveiling the Green Shades of Sustainability and Burden Shifting through Multi-Objective Optimization in Swiss Energy System Planning, JEMA, <https://arxiv.org/abs/2402.12973>\n\n\\[13\\] J. Schnidrig, A. Chuat, C. Terrier, F. Mar\u00e9chal, M. Margni (2024). Power to the People: On the Role of Districts in Decentralized Energy Systems. Energies, Vol 17, Issue 7. <https://www.mdpi.com/1996-1073/17/7/1718#>\n",
"bugtrack_url": null,
"license": null,
"summary": "Energy system modeling and analysis.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://library.energyscope.ch",
"Issues": "https://gitlab.com/energyscope/energyscope/-/issues",
"Repository": "https://gitlab.com/energyscope/energyscope"
},
"split_keywords": [
"analysis",
" energy",
" energy system",
" modeling"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3b5f44f40f1b90710a3c3905713c68a96a2b5508405e87fe1289cb1c9e9aec49",
"md5": "423f976d27c71652d25d417906b6d7f6",
"sha256": "c2d3de1a791d01deec8e0d98aac8099f9a8db3cd2b0deaa9331d9395199319d0"
},
"downloads": -1,
"filename": "energyscope-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "423f976d27c71652d25d417906b6d7f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 189340,
"upload_time": "2024-10-02T22:38:17",
"upload_time_iso_8601": "2024-10-02T22:38:17.313821Z",
"url": "https://files.pythonhosted.org/packages/3b/5f/44f40f1b90710a3c3905713c68a96a2b5508405e87fe1289cb1c9e9aec49/energyscope-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e0f0c184c45f391460253d60978478e01b8a6a14017a58c166f5962a3c798423",
"md5": "4f2d54c0719cdcdcbf61075991ff1da0",
"sha256": "57f1a2c7b15edfe80983f59707fc5efbedd1fb9e874c505eee3b7b254665b200"
},
"downloads": -1,
"filename": "energyscope-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4f2d54c0719cdcdcbf61075991ff1da0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 184049,
"upload_time": "2024-10-02T22:38:15",
"upload_time_iso_8601": "2024-10-02T22:38:15.343243Z",
"url": "https://files.pythonhosted.org/packages/e0/f0/c184c45f391460253d60978478e01b8a6a14017a58c166f5962a3c798423/energyscope-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 22:38:15",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "energyscope",
"gitlab_project": "energyscope",
"lcname": "energyscope"
}
JSON