prodrisk-shop-simulator 1.1.2
Package for simulating hydro power systems with Prodrisk first followed by SHOP using cuts from Prodrisk.
Requires Python: <4.0,>=3.10

# Prodrisk-SHOP simulator

The Prodrisk-SHOP simulator is a optimization framework for hydropower systems. It combines the stochastic mid-term model [Prodrisk](https://www.sintef.no/programvare/prodrisk/) and the short-term model [SHOP](https://www.sintef.no/programvare/shop/) to run detailed analysis for long time horizons. The simulator first runs the mid-term model to generate a strategy described with cuts, that are state dependen water value functions. The corresponding SHOP model is then optimized for a limited time horizon, typically 7 days, using the cuts from Prodrisk. The end state from one SHOP optimization is used as initial condition for the following SHOP optimization allowing serial simulation with SHOP for multiple weather scenarios. The simulator has been developed in FME HydroCen.

This work was funded by The Research Council of Norway through project no. 257588.

## Prerequisites

The simulator uses Prodrisk and SHOP, together with their python APIs [pyprodrisk](https://github.com/sintef-energy/pyprodrisk) and [pyshop](https://github.com/sintef-energy/pyshop).

## Installation

It is recommended using virtual environment in Python when using the simulator to ensure the required Python packages are not conflicting with existing installations.
The simulator comes with a basic example included that should be executed to verify that the installation is successful. Please follow the steps below to get started:

1. [Install Python](https://www.python.org/downloads/). This guide suggests using _venv_ in Python for creating virtual enviroments, but other tools should work as well.
2. Install the prodrisk-shop-simulator Python package:

```bash
pip install prodrisk-shop-simulator
```

3. Create a virtual environment with the command `python -m venv .venv`. This will create a folder inside the project called _.venv_ which is the name of the virtual environment.
4. Activate the virtual environment. This will happen automatically if you restart the terminal, or you can do it with the command `source ./.venv/Scripts/activate`.
5. Create a file `system_config.yaml` in `./examples` based on the template `./examples/system_config.yaml.tmp`. Replace the values with the appropriate values for your system. See pyshop and pyprodrisk readme for details.
6. Open [./examples/basecase/script.py](./examples/basecase/script.py) in VSCode. Make sure the path to the pyprodrisk and pyshop installations are set correct. See [https://github.com/sintef-energy/pyprodrisk](https://github.com/sintef-energy/pyprodrisk) and [https://github.com/sintef-energy/pyshop](https://github.com/sintef-energy/pyshop) for detailed instructions.
7. Execute the script.

> [!important] Prodrisk and SHOP information
> The simulator requires valid licenses for both Prodrisk and SHOP.
> Ensure you have access to these tools before running any simulations.
> For more information on obtaining licenses, or Prodrisk or SHOP specific setup, please refer to the official documentation of [Prodrisk](https://docs.prodrisk.sintef.energy/intro.html) and [SHOP](https://docs.shop.sintef.energy/intro.html).

## Results dashboard

The simulator has an integrated dashboard with various tables and plots. To launch the dashboard, please follow the steps below:

1. Make sure the virtual environment is activated, if not run the command `source ./.venv/Scripts/activate`
2. Install Streamlit with `pip install streamlit`
3. Make sure the path to the file `simulator_config.yaml` is set correctly in `dashboard/functions/functions.py`. The path can also be set directly to the dashboard interface.
4. Launch the dashboard with `streamlit run dashboard/System_overview.py`

The `resume_week` and `resume_scen` optional arguments in the function `run_serial_simulation()` can be used to resume the simulation from a given scenario and week number. If problems occur for `resume_week=1`, the resume week should be set to one of the last weeks of the previous scenario.
Note that currently the simulator does not support more than one market (of type day-ahead or spot).
The dashboard assumes that all models have corresponding Prodrisk modules.

# Publications

- [Applying the ProdRisk- SHOP simulator for investment decisions](https://hdl.handle.net/11250/2716944)
- [A Comprehensive Simulator for Hydropower Investment Decisions](https://doi.org/10.1109/PMAPS53380.2022.9810621)