diff --git a/doc/source/index.rst b/doc/source/index.rst index f9bbd34..0f0a47f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ Welcome to the PREP-SHOT Documentation ======================================= -:Authors: `Zhanwei Liu ` (liuzhanwei@u.nus.edu), `Xiaogang He ` (hexg@nus.edu.sg) -:Contributors: `Bo Xu ` (xubo_water@dlut.edu.cn), `Jingkai Xie ` (jingkai@nus.edu.sg), and `Shuyue Yan ` (shuyue.yan@u.nus.edu) +:Authors: `Zhanwei Liu `_ (liuzhanwei@u.nus.edu), `Xiaogang He `_ (hexg@nus.edu.sg) +:Contributors: `Bo Xu `_ (xubo_water@dlut.edu.cn), `Jingkai Xie `_ (jingkai@nus.edu.sg), and `Shuyue Yan `_ (shuyue.yan@u.nus.edu) :Organization: `National University of Singapore `_ :Version: |release| :Date: |today| @@ -12,7 +12,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, 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. 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. @@ -39,12 +39,12 @@ Key Features * By default, it operates on hourly-spaced time steps, but this can be adjusted. * The input data is in Excel format, while output data is generated in a NetCDF format using ``Xarray``. * It supports multiple types of solvers such as Gurobi, CPLEX, MOSEK, and GLPK via `Pyomo `_. -* It allows input of multiple scenarios for specific parameters. +* It allows the input of multiple scenarios for specific parameters. * As a pure Python program, it benefits from the use of ``pandas`` and ``Xarray``, simplifying complex data analysis and promoting extensibility. Offline documentation ---------------------- -To browse the documentation offline, you can `download an PDF copy `_ for offline reading (Synchronize updates with online documentation). +To browse the documentation offline, you can `download a PDF copy `_ for offline reading (Synchronize updates with online documentation). .. toctree:: :hidden: