From 38b84c6c1fc39d45f1cef09fd189565406aecc46 Mon Sep 17 00:00:00 2001 From: lbonaldo Date: Mon, 18 Mar 2024 17:09:35 -0400 Subject: [PATCH] Fix docs for retrofit --- docs/src/Model_Reference/Resources/retrofit.md | 8 ++++---- docs/src/User_Guide/multi_stage_input.md | 8 ++++---- test/retrofit/README.md | 15 --------------- 3 files changed, 8 insertions(+), 23 deletions(-) delete mode 100644 test/retrofit/README.md diff --git a/docs/src/Model_Reference/Resources/retrofit.md b/docs/src/Model_Reference/Resources/retrofit.md index 011377e0de..e8c0ee9744 100644 --- a/docs/src/Model_Reference/Resources/retrofit.md +++ b/docs/src/Model_Reference/Resources/retrofit.md @@ -1,5 +1,5 @@ -## Retrofit - -```@docs -GenX.retrofit +# Retrofit +```@autodocs +Modules = [GenX] +Pages = ["retrofits.jl"] ``` \ No newline at end of file diff --git a/docs/src/User_Guide/multi_stage_input.md b/docs/src/User_Guide/multi_stage_input.md index 40b4ae3b90..6ac262e1b0 100644 --- a/docs/src/User_Guide/multi_stage_input.md +++ b/docs/src/User_Guide/multi_stage_input.md @@ -59,11 +59,11 @@ Instead of one set of input files, there is one directory of input files that ne | Capital\_Recovery\_Period | The line-specific period in years over which initial capital costs must be recovered. | | WACC | The line-specific weighted average cost of capital. | -!!! note "Allowing retrofitting capacity to not contribute to minimum retirement requirements (`myopic=0` only)" +!!! note "Allowing retrofitted capacity to not contribute to minimum retirement requirements (`myopic=0` only)" Special considerations must be taken into account when utilizing the retrofit module alongside multi-stage planning, particularly when using a non zero value for the `Min_Retired_Cap_MW` column in the `Resource_multistage_data.csv` file. - 1. When assigning a non-zero value to the `Min_Retired_Cap_MW` column in the `Resource_multistage_data.csv` file, the user can specify whether the model should consider the retrofitting capacity to contribute to the minimum retirement requirement. This is done by setting the `Contribute_Min_Retirement` column to 1 for the retrofit options in the same retrofit cluster (i.e., same `Retrofit_Id`). - 2. By default, the model assumes that retrofitting capacity contributes to fulfilling minimum retirement requirements. - 3. Should users wish to exclude retrofitting capacity from contributing to minimum retirement requirements, they must set the `Contribute_Min_Retirement` column to 0 for **all** retrofit options within the same retrofit cluster (i.e., sharing the same `Retrofit_Id`). + 1. When assigning a non-zero value to the `Min_Retired_Cap_MW` column in the `Resource_multistage_data.csv` file, the user can specify whether the model should consider the retrofitted capacity to contribute to the minimum retirement requirement. This is done by setting the `Contribute_Min_Retirement` column to 1 for the retrofit options in the same retrofit cluster (i.e., same `Retrofit_Id`). + 2. By default, the model assumes that retrofitted capacity contributes to fulfilling minimum retirement requirements. + 3. Should users wish to exclude retrofitted capacity from contributing to minimum retirement requirements, they must set the `Contribute_Min_Retirement` column to 0 for **all** retrofit options within the same retrofit cluster (i.e., sharing the same `Retrofit_Id`). 4. It's important to note that this additional functionality is not currently supported when `myopic=1`. In this case, the retrofit options are only allowed to contribute to the minimum retirement requirement. Example 1: Retrofitted capacity is allowed to contribute to the minimum retirement requirement (i.e., retrofit options in the same cluster (`Retrofit_Id = 1`) all have `Contribute_Min_Retirement = 1`): diff --git a/test/retrofit/README.md b/test/retrofit/README.md deleted file mode 100644 index 12e70c5fe7..0000000000 --- a/test/retrofit/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Small New England: One Zone - -**SmallNewEngland** is set of a simplified versions of the more detailed example system RealSystemExample. It is condensed for easy comprehension and quick testing of different components of the GenX. **SmallNewEngland/OneZone** is our most basic model, a one-year example with hourly resolution containing only one zone representing New England. The model includes only natural gas, solar PV, wind, and lithium-ion battery storage with no initial capacity. - -To run the model, first navigate to the example directory at `GenX/Example_Systems/SmallNewEngland/OneZone`: - -`cd("Example_Systems/SmallNewEngland/OneZone")` - -Next, ensure that your settings in `GenX_settings.yml` are correct. The default settings use the solver Gurobi (`Solver: Gurobi`), time domain reduced input data (`TimeDomainReduction: 1`). Other optional policies include minimum capacity requirements, a capacity reserve margin, and more. A rate-based carbon cap of 50 gCO2 per kWh is specified in the `CO2_cap.csv` input file. - -Once the settings are confirmed, run the model with the `Run.jl` script in the example directory: - -`include("Run.jl")` - -Once the model has completed, results will write to the `Results` directory.