1.0 release (#101)

NREL · Jan 15, 2025 · da0ef07 · da0ef07
1 parent 8fd1a9c
commit da0ef07
Show file tree

Hide file tree

Showing 27 changed files with 483 additions and 388 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.2
+current_version = 1.0.0
 commit = true
 tag = true
 

diff --git a/README.md b/README.md
@@ -60,21 +60,13 @@ If you're curious about what we're working on, check out the roadmap:
 - [Ideas](https://github.com/NREL/R2X/issues?q=is%3Aopen+is%3Aissue+label%3AIdea): Future work or ideas for R2X.
 
 
-## Compatibility
-
-> [!WARNING]
-> 2024-11-12: Compatibility table not updated.
-
-| R2X Version  | Supported Input Model Versions          | Supported Output Model Versions         |
-|--------------|-----------------------------------------|-----------------------------------------|
-| 0.1          | ReEDS (v1, v2, v3, v4)                  | Plexos 9.000R6                           |
-| 0.2          | Sienna (PowerSystem 1.0)                | Nodal Sienna              |
-|              | ReEDS                                   | Plexos 9.000R6, 9.2000R5             |
-|              | Plexos                                  | Nodal Plexos              |
-| 0.3          | Sienna (PowerSystem 1.0)                | Nodal Sienna              |
-|              | Sienna (PowerSystem 1.0)<sup><b>*</b></sup>              | Plexos s 9.000R6, 9.2000R5             |
-|              | ReEDS                                   | Plexos 9.000R6, 9.2000R5             |
-|              | Plexos                                  | Nodal Plexos              |
+## Model compatibility
+
+| R2X Version  | Supported Input Model Versions           | Supported Output Model Versions          |
+|--------------|----------------------------------------- |----------------------------------------- |
+|     1.0      | ReEDS (v2024.8.0)                        | PLEXOS (9.0, 9.2, 10)                    |
+|              | Sienna (PSY 3.0)                         | Sienna (PSY 3.0, 4.0)                    |
+|              | PLEXOS (9.0, 9.2, 10)                    |                                          |
 
 ### Licence
 

diff --git a/docs/source/CHANGELOG.md b/docs/source/CHANGELOG.md
diff --git a/docs/source/api/config.md b/docs/source/api/config.md
@@ -1,7 +1,57 @@
-# Configuration classes
+(configuration)=
+# Configuration
 
+(configuration-models)=
+## Configuration models
 
 ```{eval-rst}
-.. automodule:: r2x.config
+.. autopydantic_settings:: r2x.config_models.BaseModelConfig
+   :settings-show-json: False
+   :settings-show-config-summary: False
+   :settings-show-validator-members: False
+   :settings-show-validator-summary: False
+   :field-list-validators: False
+```
+
+```{eval-rst}
+.. autopydantic_settings:: r2x.config_models.InfrasysConfig
+   :settings-show-json: False
+   :settings-show-config-summary: False
+   :settings-show-validator-members: False
+   :settings-show-validator-summary: False
+   :field-list-validators: False
+```
+
+```{eval-rst}
+.. autopydantic_settings:: r2x.config_models.ReEDSConfig
+   :settings-show-json: False
+   :settings-show-config-summary: False
+   :settings-show-validator-members: False
+   :settings-show-validator-summary: False
+   :field-list-validators: False
+```
+
+```{eval-rst}
+.. autopydantic_settings:: r2x.config_models.PlexosConfig
+   :settings-show-json: False
+   :settings-show-config-summary: False
+   :settings-show-validator-members: False
+   :settings-show-validator-summary: False
+   :field-list-validators: False
+```
+
+```{eval-rst}
+.. autopydantic_settings:: r2x.config_models.SiennaConfig
+   :settings-show-json: False
+   :settings-show-config-summary: False
+   :settings-show-validator-members: False
+   :settings-show-validator-summary: False
+   :field-list-validators: False
+```
+
+(scenario-models)=
+## Scenario models
+```{eval-rst}
+.. automodule:: r2x.config_scenario
     :members:
 ```
diff --git a/docs/source/api/models.md b/docs/source/api/models.md
@@ -1,114 +1,97 @@
-# Data Model
-
+# Component Models
 
 ## Topology components
 
 ```{eval-rst}
-.. autopydantic_model:: r2x.model.Area
+.. autopydantic_model:: r2x.models.Area
    :inherited-members: Component
 
-.. autopydantic_model:: r2x.model.LoadZone
+.. autopydantic_model:: r2x.models.LoadZone
 
-.. autopydantic_model:: r2x.model.ACBus
+.. autopydantic_model:: r2x.models.ACBus
    :inherited-members: Bus
 
-.. autopydantic_model:: r2x.model.DCBus
+.. autopydantic_model:: r2x.models.DCBus
    :inherited-members: Bus
 
-.. autopydantic_model:: r2x.model.DCBranch
+.. autopydantic_model:: r2x.models.DCBranch
    :inherited-members: Branch
 
-.. autopydantic_model:: r2x.model.ACBranch
+.. autopydantic_model:: r2x.models.ACBranch
    :inherited-members: Branch
 
-.. autopydantic_model:: r2x.model.MonitoredLine
+.. autopydantic_model:: r2x.models.MonitoredLine
    :inherited-members: ACBranch
 
-.. autopydantic_model:: r2x.model.TModelHVDCLine
+.. autopydantic_model:: r2x.models.TModelHVDCLine
    :inherited-members: DCBranch
 
-.. autopydantic_model:: r2x.model.Transformer2W
+.. autopydantic_model:: r2x.models.Transformer2W
    :inherited-members: ACBranch
 
-.. autopydantic_model:: r2x.model.TransmissionInterface
-
-
 ```
 
 ## Load components
 
 ```{eval-rst}
-.. autopydantic_model:: r2x.model.PowerLoad
-
-.. autopydantic_model:: r2x.model.FixedLoad
+.. autopydantic_model:: r2x.models.PowerLoad
 
-.. autopydantic_model:: r2x.model.InterruptiblePowerLoad
+.. autopydantic_model:: r2x.models.InterruptiblePowerLoad
 ```
 
 
 ## Generator models
 
 ```{eval-rst}
-.. autopydantic_model:: r2x.model.Generator
-
-.. autopydantic_model:: r2x.model.RenewableGen
-   :inherited-members: Generator
-
-.. autopydantic_model:: r2x.model.RenewableDispatch
+.. autopydantic_model:: r2x.models.Generator
    :inherited-members: RenewableGen
 
-.. autopydantic_model:: r2x.model.RenewableFix
+.. autopydantic_model:: r2x.models.RenewableDispatch
    :inherited-members: RenewableGen
 
-.. autopydantic_model:: r2x.model.ThermalGen
-   :inherited-members: Generator
-
-.. autopydantic_model:: r2x.model.ThermalStandard
-   :inherited-members: ThermalGen
+.. autopydantic_model:: r2x.models.RenewableNonDispatch
+   :inherited-members: RenewableGen
 
-.. autopydantic_model:: r2x.model.ThermalMultiStart
+.. autopydantic_model:: r2x.models.ThermalStandard
    :inherited-members: ThermalGen
 
-.. autopydantic_model:: r2x.model.HydroGen
-   :inherited-members: Generator
-
-.. autopydantic_model:: r2x.model.HydroFix
-   :inherited-members: HydroGen
-
-.. autopydantic_model:: r2x.model.HydroDispatch
+.. autopydantic_model:: r2x.models.HydroDispatch
    :inherited-members: HydroGen
 
-.. autopydantic_model:: r2x.model.HydroEnergyReservoir
+.. autopydantic_model:: r2x.models.HydroEnergyReservoir
    :inherited-members: HydroGen
 ```
 
 
 ## Storage models
 
 ```{eval-rst}
-.. autopydantic_model:: r2x.model.Storage
+.. autopydantic_model:: r2x.models.Storage
    :inherited-members: Generator
 
-.. autopydantic_model:: r2x.model.GenericBattery
+.. autopydantic_model:: r2x.models.GenericBattery
    :inherited-members: Storage
 
-.. autopydantic_model:: r2x.model.HydroPumpedStorage
+.. autopydantic_model:: r2x.models.HydroPumpedStorage
    :inherited-members: HydroGen
 
 ```
 
 ## Hybrid representation
 
 ```{eval-rst}
-.. autopydantic_model:: r2x.model.HybridSystem
+.. autopydantic_model:: r2x.models.HybridSystem
 ```
 
 ## Services
 
 ```{eval-rst}
-.. autopydantic_model:: r2x.model.Service
+.. autopydantic_model:: r2x.models.Emission
+   :inherited-members: Service
 
-.. autopydantic_model:: r2x.model.Emission
+.. autopydantic_model:: r2x.models.Reserve
+   :inherited-members: Service
 
-.. autopydantic_model:: r2x.model.Reserve
+.. autopydantic_model:: r2x.models.TransmissionInterface
+   :inherited-members: Service
 ```
diff --git a/docs/source/api/parsers.md b/docs/source/api/parsers.md
@@ -13,13 +13,6 @@
     :inherited-members:
 ```
 
-## Sienna
-```{eval-rst}
-.. automodule:: r2x.parser.sienna
-    :members:
-    :inherited-members:
-```
-
 ## Plexos
 ```{eval-rst}
 .. automodule:: r2x.parser.plexos

diff --git a/docs/source/api/plexos.md b/docs/source/api/plexos.md
@@ -1,7 +1,7 @@
-# Plexos API
+# `plexosdb`
 
 ```{eval-rst}
-.. automodule:: plexosdb.plexos_sqlite
+.. automodule:: plexosdb.sqlite
     :members:
     :inherited-members:
 ```
diff --git a/docs/source/api/system.md b/docs/source/api/system.md
@@ -1,4 +1,4 @@
-# System
+# `infrasys`
 
 ```{eval-rst}
 .. automodule:: r2x.api

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -76,3 +76,6 @@
 # Don't show class signature with the class' name.
 # autodoc_class_signature = "separated"
 suppress_warnings = ["myst.header"]
+
+# Copy button
+copybutton_exclude = ".linenos, .gp, .go"
diff --git a/docs/source/dev/develop.md b/docs/source/dev/develop.md
@@ -1,4 +1,4 @@
-# How to contribute
+# How To Contribute
 
 We welcome any contributions to R2X. Please follow this guidelines to maintain code quality and consistency.
 

diff --git a/docs/source/dev/git.md b/docs/source/dev/git.md
@@ -1,4 +1,4 @@
-# Git convention
+# Git Convention
 
 The R2X project follow a trunk based development and we try our best to have short lived branches.
 If you want to contribute to R2X first,

diff --git a/docs/source/howtos.md b/docs/source/howtos.md
@@ -0,0 +1,24 @@
+(howto)=
+# How-To's
+
+### ... upgrade an old version of ReEDS
+```console
+r2x -vv run <translation_args> --upgrade
+```
+
+### ... enable additional verbosity
+```console
+r2x -vv run --input-model <input_model> --output-model <output_model>
+```
+
+### ... convert ReEDS outputs into PLEXOS inputs.
+
+Using config file
+```console
+r2x -vv run --config user_dict.yaml
+```
+
+Using the CLI
+```console
+r2x -vv run --input-model reeds-US --output-model plexos --solve-year=2035 --weather-year=2012
+```
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,6 +1,6 @@
 # Welcome to R2X's documentation!
 
-R2X is a Framework for translating inputs/outputs of power system model to “X” model(s).
+R2X is a translating framework for inputs/outputs of power system model to “X” model(s).
 
 
 ## Model coverage
@@ -42,28 +42,20 @@ If you're curious about what we're working on, check out the roadmap:
 
 ## Model compatibility
 
-```{warning}
-This table is not up to date.
-```
-
-| R2X Version  | Supported Input Model Versions                            | Supported Output Model Versions          |
-|--------------|-----------------------------------------                  |----------------------------------------- |
-| 0.3          | Sienna (PowerSystems 3.0)                                 | Nodal Sienna                             |
-|              | Sienna (PowerSystems 4.0)                                 | Plexos s 9.000R6, 9.2000R5               |
-|              | ReEDS                                                     | Plexos 9.000R6, 9.2000R5                 |
-|              | Plexos                                                    | Nodal Plexos                             |
-| 0.4          | ReEDS (2024.2.0)                                          | Plexos 9.000R6, 9.200R5                  |
-|              | ReEDS (2024.2.0)                                          | Sienna (PowerSystems 4.0)                |
-|              | Sienna (PowerSystems 4.0)                                 | Plexos 9.000R6, 9.200R5                  |
+| R2X Version  | Supported Input Model Versions           | Supported Output Model Versions          |
+|--------------|----------------------------------------- |----------------------------------------- |
+|     1.0      | ReEDS (v2024.8.0)                        | PLEXOS (9.0, 9.2, 10)                    |
+|              | Sienna (PSY 3.0)                         | Sienna (PSY 3.0, 4.0)                    |
+|              | PLEXOS (9.0, 9.2, 10)                    |                                          |
 
 
 ```{toctree}
-:caption: Getting Started
 :hidden: true
-
 install.md
 usage.md
+howtos.md
 CHANGELOG.md
+troubleshoot.md
 ```
 
 ```{toctree}
@@ -81,8 +73,8 @@ dev/git.md
 model/logic.md
 model/diagram.md
 model/models.md
+model/data_models.md
 model/terminology.md
-api/enums.md
 ```
 
 
@@ -104,6 +96,7 @@ dev/plexosdb.md
 :caption: API Documentation
 :hidden: true
 
+api/enums.md
 api/config.md
 api/system.md
 api/plexos.md