diff --git a/doc/source/Model_input_output.rst b/doc/source/Model_input_output.rst index c9c7d23..1d0d816 100644 --- a/doc/source/Model_input_output.rst +++ b/doc/source/Model_input_output.rst @@ -366,7 +366,7 @@ Execute various scenarios By employing command-line parameters, you can execute different scenarios using the model. For example, if you wish to run a scenario referred to as "low demand," you can prepare input data named ``demand_low.xlsx``. Subsequently, when running the model, you can utilize command-line parameters to specify the scenario value. For instance, you can execute the model by executing the command ``python run.py --demand=low``. Setting global parameters ------------------------ +-------------------------- This section will guide you on how to tune the PREP-SHOT model parameters to compute the energy system for your needs. After you have prepared your input data based on the previous sections, you can proceed to tune the model parameters before you run it. diff --git a/doc/source/Running_case.rst b/doc/source/Running_case.rst index b7df5c7..a6156cb 100644 --- a/doc/source/Running_case.rst +++ b/doc/source/Running_case.rst @@ -1,6 +1,6 @@ .. _Running_case: -Running cases +Tutorial ================= In this tutorial, we'll guide you through running your first PREP-SHOT model! This example will illustrate an electricity capacity expansion scenario. diff --git a/doc/source/index.rst b/doc/source/index.rst index 379199f..00a7b33 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,7 +3,7 @@ Welcome to the PREP-SHOT Documentation ======================================= -:Author: `Zhanwei Liu `_ (Mr), and `Xiaogang He `_ (Dr), +:Authors: `Zhanwei Liu `_ (Mr), and `Xiaogang He `_ (Dr), , `Bo Xu `_ (Dr), `Jingkai Xie `_ (Dr), `Shuyue Yan `_ (Ms) :Organization: `National University of Singapore `_ :Version: |release| :Date: |today| @@ -11,7 +11,7 @@ Welcome to the PREP-SHOT Documentation Overview -------- -**PREP-SHOT** (**P**\ athways for **R**\ enewable **E**\ nergy **P**\ lanning coupling **S**\ hort-term **H**\ ydropower **O**\ pera\ **T**\ ion) is a transparent, modular, and open-source energy expansion model hosted on `GitHub `_. Offering advanced solutions for multi-scale, intertemporal, and cost-effective expansion of energy systems and transmission lines. PREP-SHOT was orginally developed to study the nexus between water and energy systems. The development started in 2021, and in 2022, it was released as an open-source model. +**PREP-SHOT** (**P**\ athways for **R**\ enewable **E**\ nergy **P**\ lanning coupling **S**\ hort-term **H**\ ydropower **O**\ pera\ **T**\ ion) 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. PREP-SHOT was orginally developed to study the nexus between water and energy systems. The development started in 2021, and in 2022, it was released as an open-source model. The model sets itself apart from existing energy expansion models through its deeper consideration of hydropower processes. While models such as `urbs `_ might treat hydropower as fixed processes, and others like `GenX `_ and `PLEXOS `_ may not fully capture the dynamic nature of water heads or consolidate multiple hydropower stations into a single unit, PREP-SHOT is uniquely designed to address these oversights.