Data

Tools

Indexes

Applications

Experiments

Open Source Science

PREP-SHOT

Pathways for Renewable Energy Planning coupling Short-term Hydropower OperaTion

https://github.com/PREP-NexT/PREP-SHOT

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 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: researchgate.net
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary

Keywords

hydropower renewable-energy reservoir-modeling
Last synced: 6 months ago · JSON representation

Repository

Pathways for Renewable Energy Planning coupling Short-term Hydropower OperaTion

Basic Info
Statistics
  • Stars: 441
  • Watchers: 10
  • Forks: 23
  • Open Issues: 1
  • Releases: 1
Topics
hydropower renewable-energy reservoir-modeling
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

PREP-SHOT logo

Build GitHub contributors GitHub issues Twitter Follow License Download Google Colab

Overview | Features | Quick Start | Contribute | Roadmap | Citation

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. PREPSHOT_Update07 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.

  1. Clone the repo

    bash git clone https://github.com/PREP-NexT/PREP-SHOT.git

  2. Install the dependencies

    bash cd PREP-SHOT conda create -n prep-shot python=3.8 conda activate prep-shot pip install -r requirements.txt

  3. Run your first model

    bash 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.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Citing PREP-SHOT

See the Citation Guide.

Please use the following logo if you use PREP-SHOT:

PREP-SHOT_logos_QR

If you use PREP-SHOT in a scientific publication, we would appreciate citations. You can use the following BibTeX entry:

bibtex @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

  • [x] Benders decomposition-based fast solution framework
  • [x] PyOptInterface-based low-memory and fast modelling engine
  • [x] 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

Repo Analytics

⭐ Star History

Star History Chart

Owner

  • Name: PREP-NexT
  • Login: PREP-NexT
  • Kind: organization
  • Email: hexg@nus.edu.sg
  • Location: Singapore

Pathways for REsilient Planning of water-energy-food Nexus Transformation

GitHub Events

Total
  • Issues event: 2
  • Watch event: 76
  • Issue comment event: 2
  • Push event: 28
  • Pull request event: 12
  • Fork event: 5
Last Year
  • Issues event: 2
  • Watch event: 76
  • Issue comment event: 2
  • Push event: 28
  • Pull request event: 12
  • Fork event: 5

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 280
  • Total Committers: 9
  • Avg Commits per committer: 31.111
  • Development Distribution Score (DDS): 0.386
Past Year
  • Commits: 36
  • Committers: 5
  • Avg Commits per committer: 7.2
  • Development Distribution Score (DDS): 0.333
Top Committers
Name Email Commits
LIU ZHANWEI 5****u 172
github-actions[bot] g****] 38
jye-lim j****m@o****m 29
Xiaogang He h****7@g****m 24
sherryyan1 1****1 13
metab0t m****t@o****m 1
KelvinZhang99 k****9@g****m 1
Jingkai-Xie 1****e 1
Hem-W h****g@o****m 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 23
  • Average time to close issues: N/A
  • Average time to close pull requests: about 11 hours
  • Total issue authors: 0
  • Total pull request authors: 5
  • Average comments per issue: 0
  • Average comments per pull request: 0.17
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 minutes
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • nene112 (1)
Pull Request Authors
  • Zhanwei-Liu (17)
  • jye-lim (6)
  • sherryyan1 (5)
  • Hem-W (2)
  • KelvinZhang99 (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 4
proxy.golang.org: github.com/prep-next/prep-shot
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/PREP-NexT/PREP-SHOT
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago

Dependencies

.github/workflows/static.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • peaceiris/actions-gh-pages v3 composite
doc/requirements.txt pypi
  • 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