PREP-SHOT
A transparent, modular, and open-source Energy Capacity Expansion Model.
https://github.com/PREP-NexT/PREP-SHOT
Category: Energy Systems
Sub Category: Energy System Modeling Frameworks
Keywords
hydropower renewable-energy reservoir-modeling
Keywords from Contributors
climate-change flood geocode virtualization
Last synced: about 14 hours ago
JSON representation
Repository metadata
Pathways for Renewable Energy Planning coupling Short-term Hydropower OperaTion
- Host: GitHub
- URL: https://github.com/PREP-NexT/PREP-SHOT
- Owner: PREP-NexT
- License: gpl-3.0
- Created: 2022-05-29T12:03:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-24T11:29:33.000Z (3 days ago)
- Last Synced: 2025-04-25T12:06:19.174Z (1 day ago)
- Topics: hydropower, renewable-energy, reservoir-modeling
- Language: Jupyter Notebook
- Homepage: https://prep-next.github.io/PREP-SHOT/
- Size: 38.3 MB
- Stars: 413
- Watchers: 9
- Forks: 19
- Open Issues: 0
- Releases: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
README.md
Overview
PREP-SHOT (Pathways for Renewable Energy Planning coupling Short-term Hydropower OperaTion) is a transparent, modular, and open-source energy expansion model, offering advanced solutions for multi-scale, intertemporal, and cost-effective expansion of energy systems and transmission lines. It's developed by Zhanwei Liu and Xiaogang He from the PREP-NexT Lab at the National University of Singapore.
For more information, please visit the Official Documentation.
This project is licensed under the GNU General Public License 3.0.
Why the Name?
The clean energy transition is our new moonshot to combat climate change – an ambitious 'shot' yet achievable. We're up to the challenge, which is why we developed PREP-SHOT to prepare us for this long shot.
Key Features
- Optimization model based on linear programming for multi-zone energy systems.
- Cost minimization while meeting given demand time series.
- Adjustable operation on hourly-spaced time steps.
- Input data in Excel format and output data in
NetCDF
format using Xarray. - Support for multiple solvers like HiGHS , GUROBI, COPT, and MOSEK via PyOptInterface.
- Allows input of multiple scenarios for specific parameters.
- A pure Python program, leveraging pandas and Xarray for simplified complex data analysis and extensibility.
Getting Started
This section includes a brief tutorial on running your first PREP-SHOT model.
-
Clone the repo
git clone https://github.com/PREP-NexT/PREP-SHOT.git
-
Install the dependencies
cd PREP-SHOT conda create -n prep-shot python=3.8 conda activate prep-shot pip install -r requirements.txt
-
Run your first model
python run.py
This example is inspired by real-world data. For a detailed elaboration of this tutorial, check out the Tutorial Page in our documentation.
By default, PREP-SHOT uses open-source HiGHS solver. Solver-specific parameters are specified in the config.json
file, which should be located in the current working directory. Additionaly, we provide the option to use one of the following three commercial solvers:
🤝 How to Contribute
To contribute to this project, please read our Contributing Guidelines.
Citation
If you use PREP-SHOT in a scientific publication, we would appreciate citations. You can use the following BibTeX entry:
@article{liu2023,
title = {Balancing-oriented hydropower operation makes the clean energy transition more affordable and simultaneously boosts water security},
author = {Liu, Zhanwei and He, Xiaogang},
journal = {Nature Water},
volume = {1},
pages = {778--789},
year = {2023},
doi = {10.1038/s44221-023-00126-0},
}
Contact Us
If you have any questions, comments, or suggestions that aren't suitable for public discussions in the Issues section, please feel free to reach out to Zhanwei Liu.
Please use the GitHub Issues for public discussions related to bugs, enhancements, or other project-related discussions.
Roadmap
-
Benders
decomposition-based fast solution framework -
PyOptInterface
-based low-memory and fast modelling engine - Support for input of cost–supply curves of technologies
- Support for expanding conventional hydropower plants
- Support for refurbishing conventional hydropower plants to pumped-storage schemes
- Support for refurbishing carbon-emission plants to carbon capture and storage (CCS) schemes
Disclaimer
The PREP-SHOT model is an academic project and is not intended to be used as a precise prediction tool for specific hydropower operations or energy planning. The developers will not be held liable for any decisions made based on the use of this model. We recommend applying it in conjunction with expert judgment and other modeling tools in a decision-making context.
Repo Activity
⭐ Star History
Owner metadata
- Name: PREP-NexT
- Login: PREP-NexT
- Email: [email protected]
- Kind: organization
- Description: Pathways for REsilient Planning of water-energy-food Nexus Transformation
- Website:
- Location: Singapore
- Twitter: PREPNexT_Lab
- Company:
- Icon url: https://avatars.githubusercontent.com/u/93474760?v=4
- Repositories: 2
- Last ynced at: 2023-03-03T09:33:22.446Z
- Profile URL: https://github.com/PREP-NexT
GitHub Events
Total
- Watch event: 52
- Push event: 18
- Pull request event: 2
- Fork event: 1
Last Year
- Watch event: 52
- Push event: 18
- Pull request event: 2
- Fork event: 1
Committers metadata
Last synced: 5 days ago
Total Commits: 265
Total Committers: 7
Avg Commits per committer: 37.857
Development Distribution Score (DDS): 0.351
Commits in past year: 70
Committers in past year: 4
Avg Commits per committer in past year: 17.5
Development Distribution Score (DDS) in past year: 0.457
Name | Commits | |
---|---|---|
LIU ZHANWEI | 5****u | 172 |
jye-lim | j****m@o****m | 29 |
github-actions[bot] | g****] | 25 |
Xiaogang He | h****7@g****m | 24 |
sherryyan1 | 1****1 | 13 |
metab0t | m****t@o****m | 1 |
Jingkai-Xie | 1****e | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 0
Total pull requests: 18
Average time to close issues: N/A
Average time to close pull requests: about 14 hours
Total issue authors: 0
Total pull request authors: 3
Average comments per issue: 0
Average comments per pull request: 0.22
Merged pull request: 18
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 5
Past year average time to close issues: N/A
Past year average time to close pull requests: 1 minute
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.0
Past year merged pull request: 5
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
Top Pull Request Authors
- jye-lim (7)
- Zhanwei-Liu (6)
- sherryyan1 (5)
Top Issue Labels
Top Pull Request Labels
Dependencies
- actions/checkout v2 composite
- actions/setup-python v2 composite
- peaceiris/actions-gh-pages v3 composite
- pygments ==2.15.0
- sphinx ==4.4.0
- sphinx-notfound-page ==0.8.3
- sphinx-tabs ==3.4.0
- sphinx_rtd_theme ==1.1.1
- sphinxcontrib-bibtex ==2.6.1
- sphinxext-opengraph ==0.7.5
Score: 7.969357742016347