Documentation updates: migrate enumerated type docs into scoped enum docstrings

docs/make.jl

@@ -42,8 +42,15 @@ pages = OrderedDict(
                 "Save and read data with a JSON" => "how_to/serialize_data.md",
             ],
             "...add a component using natural units (MW)" => "how_to/add_component_natural_units.md",
+            "...read component values in different unit systems" => "how_to/convert_unit_systems.md",
+            "...convert transformer impedances between per-unit bases" => "how_to/convert_transformer_impedance.md",
+            "...use subsystems" => "how_to/use_subsystems.md",
             "...use context managers for bulk operations" => "how_to/use_context_managers.md",
-            "...add additional data to a component" => "how_to/adding_additional_fields.md",
+            "...add additional data to a component" => Any[
+                "Add Supplemental Attributes to a System" => "how_to/add_supplemental_attributes.md",
+                "Use Supplemental Attributes" => "how_to/use_supplemental_attributes.md",
+                "Add additional fields to a component" => "how_to/adding_additional_fields.md",
+            ],
             "...add time-series data" => Any[
                 "Parse time series data from .csv files" => "how_to/parse_ts_from_csvs.md",
                 "Improve performance with time series data" => "how_to/improve_ts_performance.md",
@@ -72,10 +79,9 @@ pages = OrderedDict(
             "explanation/per_unit.md",
             "explanation/power_concepts.md",
             "explanation/conforming_and_non_conforming_loads.md",
-            "explanation/transformer_per_unit_models.md",
             "explanation/time_series.md",
             "explanation/dynamic_data.md",
-            "explanation/supplemental_attributes.md",
+            "explanation/supplemental_attributes_2.md",
             "explanation/plant_attributes.md",
             ],
         "Model Library" => Any[],

docs/src/api/enumerated_types.md

@@ -92,7 +92,7 @@ EIA Annual Energy Review. `ThermalFuels` has the options:
 | `BLACK_LIQUOR`                                                                                                                     | BLQ           | Black Liquor                                                                                                                        |
 | `WOOD_WASTE_LIQUIDS`                                                                                                               | WDL           | Wood Waste Liquids excluding Black Liquor (includes red liquor, sludge wood, spent sulfite liquor, and other wood-based liquids)    |
 | `LANDFILL_GAS`                                                                                                                     | LFG           | Landfill Gas                                                                                                                        |
-| `OTHEHR_BIOMASS_GAS`                                                                                                               | OBG           | Other Biomass Gas (includes digester gas, methane, and other biomass gasses)                                                        |
+| `OTHER_BIOMASS_GAS`                                                                                                                | OBG           | Other Biomass Gas (includes digester gas, methane, and other biomass gasses)                                                        |
 | `NUCLEAR`                                                                                                                          | NUC           | Nuclear Uranium, Plutonium, Thorium                                                                                                 |
 | `WASTE_HEAT`                                                                                                                       | WH            | Waste heat not directly attributed to a fuel source                                                                                 |
 | `TIREDERIVED_FUEL`                                                                                                                 | TDF           | Tire-derived Fuels                                                                                                                  |
@@ -159,7 +159,7 @@ the different alternatives of `ReservoirDataType`, which has the options:
 | `CONFORMING`     | Conforming load                                                   |
 | `UNDEFINED`      | Undefined or unknown whether load is conforming or non-conforming |
 
-## [Tranformer Control Objectives](@id xtf_crtl)
+## [Transformer Control Objectives](@id xtf_crtl)
 
 `TransformerControlObjective` is used to select the control objective for a transformer's
 tap changer, which can be used to determine the tap position during power flow calculations.

docs/src/api/glossary.md

@@ -1,7 +1,7 @@
 # Glossary and Acronyms
 
-[A](@ref) | [D](@ref) | [E](@ref) | [F](@ref) | [H](@ref) | [I](@ref) | [O](@ref) | [P](@ref) | [R](@ref) |
-[S](@ref) | [V](@ref) | [W](@ref) | [Z](@ref)
+[A](@ref) | [C](@ref) | [D](@ref) | [E](@ref) | [F](@ref) | [H](@ref) | [I](@ref) | [O](@ref) | [P](@ref) | [R](@ref) |
+[S](@ref) | [U](@ref) | [V](@ref) | [W](@ref) | [Z](@ref)
 
 ### A
 
@@ -13,25 +13,47 @@
 
   - *AVR*: Automatic Voltage Regulator
 
+### C
+
+  - *CA*: EIA prime mover code for the steam turbine (combined cycle steam) portion of a combined cycle plant
+
+  - *CAISO*: California Independent System Operator
+
+  - *CC*: EIA prime mover code for combined cycle units
+
+  - *CT*: Combustion Turbine
+
 ### D
 
   - *DC*: Direct current
 
   - *DERA1*:
 
+  - *Deterministic*: mathematical model in which the outcomes are precisely determined through known relationships among states and events. For contrast, see the definition of [Probabilistic](@ref P).
+
   - *Dynamic*: Refers to data and simulations for power system transient simulations using differential
     equations. Common examples include signal stability analysis to verify the power system will
     maintain stability in the few seconds following an unexpected fault or generator trip. For contrast,
     see the definition for [Static](@ref S) data.
 
 ### E
 
+  - *EIA*: U.S. Energy Information Administration
+
+  - *EIM*: Energy Imbalance Market
+
   - *EMF*: Electromotive force
+
   - *ESAC*: IEEE Type AC Excitation System model
+
   - *ESDC*: IEEE Type DC Excitation System model
+
   - *EXAC*: IEEE Type AC Excitation System (modified) model
+
   - *EXPIC*: Proportional/Integral Excitation System from PSS/E
+
   - *EXST*: IEEE Type ST (Static) Excitation System model
+
   - *EX4VSA*: IEEE Excitation System for Voltage Security Assessment with Over-Excitation Limits.
 
 ### F
@@ -53,6 +75,8 @@
     forecast included the next day plus a 24-hour lookahead window, the horizon would be
     `Dates.Hour(48)` or `Dates.Day(2)`. See the article on [`Time Series Data`](@ref ts_data).
 
+  - *HRSG*: Heat Recovery Steam Generator
+
   - *HVDC*: High-voltage DC
 
 ### I
@@ -83,6 +107,8 @@
 
 ### P
 
+  - *PCC*: Point of Common Coupling. The point where a generator or plant connects to the grid.
+
   - *PLL*: Phase-locked loop
 
   - *PSS*: Power System Stabilizer
@@ -91,6 +117,8 @@
 
   - *PPA*: Power purchase agreement
 
+  - *Probabilistic*: mathematical model in which the outcomes represent random phenomenon. For contrast, see the definition of [Deterministic](@ref D).
+
   - *PSI*: [`PowerSimulations.jl`](https://nrel-sienna.github.io/PowerSimulations.jl/latest/)
 
   - *PSID*: [`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/)
@@ -101,6 +129,8 @@
 
   - *pu* or *p.u.*: Per-unit
 
+  - *PWM*: Pulse-width modulation. A switching technique used in power converters to synthesize a desired AC output voltage by rapidly toggling switches at a high frequency.
+
 ### R
 
   - *REECB1*: Renewable Energy Electric Controller Type B1
@@ -117,22 +147,25 @@
 
   - *SIL*: Surge impedance loading
 
+  - *ST*: Steam Turbine
+
   - *States*: Correspond to the set of inputs, outputs or variables, that evolve dynamically in
-    [`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/),
-    commonly via a differential-algebraic system of equations. In `PowerSystems.jl`, a component
-    associated to a `DynamicInjector` (for example an AVR) specifies the set of states that specific
-    component requires to be modeled accurately.
-
-  - *Static*: Typically refers to steady state data or models where the power system
-    and each of its components are assumed to be operating at a steady state equilibrium point. This
-    includes both power flow data for a single time point simulation as well as quasi-static time
-    series data and models, where the power system is at an equilibrium point at each time step.
-    Static data can be used as the input to single time point power flow models and production
-    cost models with, for example, 5-minute, 15-minute, or 1-hour [Resolution](@ref R).
-    For contrast, see the definition for [Dynamic](@ref D) data.
+    [`PowerSimulationsDynamics.jl`](https://nrel-sienna.github.io/PowerSimulationsDynamics.jl/stable/), commonly via a differential-algebraic system of equations. In `PowerSystems.jl`, a component associated to a `DynamicInjector` (for example an AVR) specifies the set of states that specific component requires to be modeled accurately.
+
+  - *Static*: Typically refers to steady state data or models where the power system and each of its components are assumed to be operating at a steady state equilibrium point. This includes both power flow data for a single time point simulation as well as quasi-static time   series data and models, where the power system is at an equilibrium point at each time step. Static data can be used as the input to single time point power flow models and production cost models with, for example, 5-minute, 15-minute, or 1-hour [Resolution](@ref R).    For contrast, see the definition for [Dynamic](@ref D) data.
 
   - *STAB*: Speed Sensitive Stabilizing PSS Model
 
+  - *Struct*: A composite data type in Julia that can store multiple values in a single object. See the Julia documentation on [`struct`](https://docs.julialang.org/en/v1/base/base/#struct)
+    and [Composite Types](https://docs.julialang.org/en/v1/manual/types/#Composite-Types).
+
+  - *SVM*: Space vector modulation. A control algorithm for three-phase inverters that represents the desired output voltage as a vector in the complex plane and selects switching states to approximate it, achieving lower harmonic distortion than basic [PWM](@ref D).
+
+### U
+
+  - *UUID*: Universally Unique Identifier. A 128-bit identifier formatted as a 32-character
+    hexadecimal string (e.g. `5f180c4c-cd81-4b80-8c60-627c28aef8b0`).
+
 ### V
 
   - *VSCLine*: Voltage-Source Converter HVDC Line
@@ -141,6 +174,8 @@
 
 ### W
 
+  - *WECC*: Western Electricity Coordinating Council
+
   - *Window*: A forecast window is one forecast run that starts at one [initial time](@ref I)
     and extends through the forecast [horizon](@ref H). Typically, a forecast data set
     contains multiple forecast windows, with sequential initial times. For example, a

docs/src/api/public.md

@@ -10,7 +10,7 @@ Pages   = ["PowerSystems.jl",
            "injection.jl",
            "devices.jl",
            "loads.jl",
-           "supplemental_constructors",
+           "supplemental_constructors.jl",
            "generation.jl",
            "reserves.jl",
            "storage.jl",
@@ -20,7 +20,6 @@ Pages   = ["PowerSystems.jl",
            "static_models.jl",
            "subsystems.jl",
            "static_injection_subsystem.jl",
-           "dynamic_models.jl",
            "operational_cost.jl",
            "cost_function_timeseries.jl",
            "definitions.jl"

docs/src/api/static_injection_subtypes.md

@@ -41,7 +41,7 @@ This document summarizes the similarities and differences between [`StaticInject
 
 ² EnergyReservoirStorage uses `input_active_power_limits` and `output_active_power_limits` instead
 
-Here, "`MinMax` (optional)" means `Union{MinMax, Nothing}`, with `nothing` repesenting "no limits" and being the default.
+Here, "`MinMax` (optional)" means `Union{MinMax, Nothing}`, with `nothing` representing "no limits" and being the default.
 
 ⊕ = Split across 3 ZIP fields: `*_constant_*`, `*_impedance_*`, `*_current_*`