zhangshuo20 / prep-shot Goto Github PK

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 our Official Documentation.

This project is licensed under the GNU General Public License 3.0.

• 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 Gurobi, CPLEX, MOSEK, and GLPK via Pyomo.
• Allows input of multiple scenarios for specific parameters.
• A pure Python program, leveraging pandas and Xarray for simplified complex data analysis and extensibility.

This section includes a brief tutorial on running your first PREP-SHOT model.

Ensure that Python 3.7 is installed.

1. Clone the repo

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

2. Create the Conda Environment and install the dependencies

   conda env create -f prep-shot.yml

3. Activate the Conda Environment

   conda activate prep-shot

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

To contribute to this project, please read our Contributing Guidelines.

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

@misc{PREP-SHOT,
  author = {Zhanwei Liu and Xiaogang He},
  title = {PREP-SHOT: Pathways for Renewable Energy Planning coupling Short-term Hydropower OperaTion},
  url = {https://github.com/PREP-NexT/PREP-SHOT},
  version = {0.1}, 
  year = {2023},
}

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.

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.