Regenerate structs

src/models/generated/ACBus.jl

@@ -22,30 +22,30 @@ This file is auto-generated. Do not edit.
 An AC bus.
 
 # Arguments
-- `number::Int`: number associated with the bus
+- `number::Int`: A unique bus identification number (positive integer)
 - `name::String`: Name of the component. Components of the same type (e.g., `PowerLoad`) must have unique names, but components of different types (e.g., `PowerLoad` and `ACBus`) can have the same name.
 - `bustype::Union{Nothing, ACBusTypes}`: Used to describe the connectivity and behavior of this bus. [Options are listed here.](@ref acbustypes_list)
 - `angle::Union{Nothing, Float64}`: angle of the bus in radians, validation range: `(-1.571, 1.571)`, action if invalid: `error`
-- `magnitude::Union{Nothing, Float64}`: voltage as a multiple of basevoltage, validation range: `voltage_limits`, action if invalid: `warn`
-- `voltage_limits::Union{Nothing, MinMax}`: limits on the voltage variation as multiples of basevoltage
+- `magnitude::Union{Nothing, Float64}`: voltage as a multiple of `base_voltage`, validation range: `voltage_limits`, action if invalid: `warn`
+- `voltage_limits::Union{Nothing, MinMax}`: limits on the voltage variation as multiples of `base_voltage`
 - `base_voltage::Union{Nothing, Float64}`: the base voltage in kV, validation range: `(0, nothing)`, action if invalid: `error`
 - `area::Union{Nothing, Area}`: (optional) the area containing the bus
 - `load_zone::Union{Nothing, LoadZone}`: (optional) the load zone containing the bus
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
 - `internal::InfrastructureSystemsInternal`: (**Do not modify.**) PowerSystems.jl internal reference.
 """
 mutable struct ACBus <: Bus
-    "number associated with the bus"
+    "A unique bus identification number (positive integer)"
     number::Int
     "Name of the component. Components of the same type (e.g., `PowerLoad`) must have unique names, but components of different types (e.g., `PowerLoad` and `ACBus`) can have the same name."
     name::String
     "Used to describe the connectivity and behavior of this bus. [Options are listed here.](@ref acbustypes_list)"
     bustype::Union{Nothing, ACBusTypes}
     "angle of the bus in radians"
     angle::Union{Nothing, Float64}
-    "voltage as a multiple of basevoltage"
+    "voltage as a multiple of `base_voltage`"
     magnitude::Union{Nothing, Float64}
-    "limits on the voltage variation as multiples of basevoltage"
+    "limits on the voltage variation as multiples of `base_voltage`"
     voltage_limits::Union{Nothing, MinMax}
     "the base voltage in kV"
     base_voltage::Union{Nothing, Float64}

src/models/generated/AGC.jl

@@ -19,12 +19,14 @@ This file is auto-generated. Do not edit.
         internal::InfrastructureSystemsInternal
     end
 
+Automatic generation control (AGC) for the system or a certain `Area` within the system.
 
+This model uses a proportional–integral–derivative (PID) control to simulate a "smooth" response of the AGC to the area control error (ACE). Refer to ["AGC Simulation Model for Large Renewable Energy Penetration Studies."](https://doi.org/10.1109/NAPS50074.2021.9449687)
 
 # Arguments
 - `name::String`: Name of the component. Components of the same type (e.g., `PowerLoad`) must have unique names, but components of different types (e.g., `PowerLoad` and `ACBus`) can have the same name.
 - `available::Bool`: Indicator of whether the component is connected and online (`true`) or disconnected, offline, or down (`false`). Unavailable components are excluded during simulations.
-- `bias::Float64`
+- `bias::Float64`: Area frequency bias in MW/Hz
 - `K_p::Float64`: PID Proportional Constant
 - `K_i::Float64`: PID Integral Constant
 - `K_d::Float64`: PID Derivative Constant
@@ -39,6 +41,7 @@ mutable struct AGC <: Service
     name::String
     "Indicator of whether the component is connected and online (`true`) or disconnected, offline, or down (`false`). Unavailable components are excluded during simulations."
     available::Bool
+    "Area frequency bias in MW/Hz"
     bias::Float64
     "PID Proportional Constant"
     K_p::Float64

src/models/generated/AVRFixed.jl

@@ -18,26 +18,26 @@ This file is auto-generated. Do not edit.
 Parameters of a AVR that returns a fixed voltage to the rotor winding
 
 # Arguments
-- `Vf::Float64`: Fixed voltage field applied to the rotor winding in pu ([`Device Base`](@ref per_unit)), validation range: `(0, nothing)`
+- `Vf::Float64`: Fixed voltage field applied to the rotor winding in pu ([`DEVICE_BASE`](@ref per_unit)), validation range: `(0, nothing)`
 - `V_ref::Float64`: (optional) Reference Voltage Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) Fixed AVR has no states
-- `n_states::Int`: (**Do not modify.**) Fixed AVR has no states
-- `states_types::Vector{StateTypes}`: (**Do not modify.**) Fixed AVR has no states
+- `states::Vector{Symbol}`: (**Do not modify.**) Fixed AVR has no [states](@ref S)
+- `n_states::Int`: (**Do not modify.**) Fixed AVR has no [states](@ref S)
+- `states_types::Vector{StateTypes}`: (**Do not modify.**) Fixed AVR has no [states](@ref S)
 - `internal::InfrastructureSystemsInternal`: (**Do not modify.**) PowerSystems.jl internal reference.
 """
 mutable struct AVRFixed <: AVR
-    "Fixed voltage field applied to the rotor winding in pu ([`Device Base`](@ref per_unit))"
+    "Fixed voltage field applied to the rotor winding in pu ([`DEVICE_BASE`](@ref per_unit))"
     Vf::Float64
     "(optional) Reference Voltage Set-point (pu)"
     V_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) Fixed AVR has no states"
+    "(**Do not modify.**) Fixed AVR has no [states](@ref S)"
     states::Vector{Symbol}
-    "(**Do not modify.**) Fixed AVR has no states"
+    "(**Do not modify.**) Fixed AVR has no [states](@ref S)"
     n_states::Int
-    "(**Do not modify.**) Fixed AVR has no states"
+    "(**Do not modify.**) Fixed AVR has no [states](@ref S)"
     states_types::Vector{StateTypes}
     "(**Do not modify.**) PowerSystems.jl internal reference."
     internal::InfrastructureSystemsInternal

src/models/generated/AVRSimple.jl

@@ -22,9 +22,9 @@ i.e. an integrator controller on EMF
 - `Kv::Float64`: Proportional Gain, validation range: `(0, nothing)`
 - `V_ref::Float64`: (optional) Reference Voltage Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states are:
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) are:
 	Vf: field voltage
-- `n_states::Int`: (**Do not modify.**) Fixed AVR has 1 states
+- `n_states::Int`: (**Do not modify.**) Fixed AVR has 1 [state](@ref S)
 - `states_types::Vector{StateTypes}`: (**Do not modify.**) Simple AVR has 1 [differential](@ref states_list) [states](@ref S)
 - `internal::InfrastructureSystemsInternal`: (**Do not modify.**) PowerSystems.jl internal reference.
 """
@@ -35,10 +35,10 @@ mutable struct AVRSimple <: AVR
     V_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states are:
+    "(**Do not modify.**) The [states](@ref S) are:
 	Vf: field voltage"
     states::Vector{Symbol}
-    "(**Do not modify.**) Fixed AVR has 1 states"
+    "(**Do not modify.**) Fixed AVR has 1 [state](@ref S)"
     n_states::Int
     "(**Do not modify.**) Simple AVR has 1 [differential](@ref states_list) [states](@ref S)"
     states_types::Vector{StateTypes}

src/models/generated/AVRTypeI.jl

@@ -39,7 +39,7 @@ Parameters of an Automatic Voltage Regulator Type I - Resembles IEEE Type DC1
 - `Be::Float64`: 2nd ceiling coefficient, validation range: `(0, nothing)`
 - `V_ref::Float64`: (optional) Reference Voltage Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states are:
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) are:
 	Vf: Voltage field,
 	Vr1: Amplifier State,
 	Vr2: Stabilizing Feedback State,
@@ -73,7 +73,7 @@ mutable struct AVRTypeI <: AVR
     V_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states are:
+    "(**Do not modify.**) The [states](@ref S) are:
 	Vf: Voltage field,
 	Vr1: Amplifier State,
 	Vr2: Stabilizing Feedback State,

src/models/generated/AVRTypeII.jl

@@ -39,7 +39,7 @@ Parameters of an Automatic Voltage Regulator Type II -  Typical static exciter m
 - `Be::Float64`: 2nd ceiling coefficient, validation range: `(0, nothing)`
 - `V_ref::Float64`: (optional) Reference Voltage Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states are:
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) are:
 	Vf: Voltage field,
 	Vr1: First Lead-Lag state,
 	Vr2: Second lead-lag state,
@@ -73,7 +73,7 @@ mutable struct AVRTypeII <: AVR
     V_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states are:
+    "(**Do not modify.**) The [states](@ref S) are:
 	Vf: Voltage field,
 	Vr1: First Lead-Lag state,
 	Vr2: Second lead-lag state,

src/models/generated/ActiveConstantPowerLoad.jl

@@ -32,7 +32,7 @@ This file is auto-generated. Do not edit.
         internal::InfrastructureSystemsInternal
     end
 
-Parameters of 12-states active power load based on the paper Dynamic Stability of a Microgrid With an Active Load from N. Bottrell, M. Prodanovic and T. Green in IEEE Transactions on Power Electronics, 2013.
+Parameters of 12-[states](@ref S) active power load based on the paper, ["Dynamic Stability of a Microgrid With an Active Load."](https://doi.org/10.1109/TPEL.2013.2241455)
 
 # Arguments
 - `name::String`: Name of the component. Components of the same type (e.g., `PowerLoad`) must have unique names, but components of different types (e.g., `PowerLoad` and `ACBus`) can have the same name.
@@ -55,8 +55,8 @@ Parameters of 12-states active power load based on the paper Dynamic Stability o
 - `Q_ref::Float64`: (optional) Reference reactive power (pu)
 - `V_ref::Float64`: (optional) Reference voltage (pu)
 - `ω_ref::Float64`: (optional) Reference frequency (pu)
-- `is_filter_differential::Int`: (optional) Boolean to decide if filter states are differential or algebraic
-- `states::Vector{Symbol}`: (**Do not modify.**) The states are:
+- `is_filter_differential::Int`: (optional) Boolean to decide if filter [states](@ref S) are differential or algebraic
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) are:
 	θ_pll: PLL deviation angle, 
 	ϵ_pll: PLL integrator state, 
 	η: DC-voltage controller integrator state, 
@@ -113,9 +113,9 @@ mutable struct ActiveConstantPowerLoad <: DynamicInjection
     V_ref::Float64
     "(optional) Reference frequency (pu)"
     ω_ref::Float64
-    "(optional) Boolean to decide if filter states are differential or algebraic"
+    "(optional) Boolean to decide if filter [states](@ref S) are differential or algebraic"
     is_filter_differential::Int
-    "(**Do not modify.**) The states are:
+    "(**Do not modify.**) The [states](@ref S) are:
 	θ_pll: PLL deviation angle, 
 	ϵ_pll: PLL integrator state, 
 	η: DC-voltage controller integrator state, 

src/models/generated/ActivePowerDroop.jl

@@ -21,7 +21,7 @@ Parameters of an Active Power droop controller
 - `ωz::Float64`: filter frequency cutoff, validation range: `(0, nothing)`
 - `P_ref::Float64`: (optional) Reference Power Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states of the ActivePowerDroop model are:
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) of the ActivePowerDroop model are:
 	θ_oc: Phase angle displacement of the inverter model,
 	p_oc: Measured active power of the inverter model
 - `n_states::Int`: (**Do not modify.**) ActivePowerDroop has two states
@@ -35,7 +35,7 @@ mutable struct ActivePowerDroop <: ActivePowerControl
     P_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states of the ActivePowerDroop model are:
+    "(**Do not modify.**) The [states](@ref S) of the ActivePowerDroop model are:
 	θ_oc: Phase angle displacement of the inverter model,
 	p_oc: Measured active power of the inverter model"
     states::Vector{Symbol}

src/models/generated/ActivePowerPI.jl

@@ -23,7 +23,7 @@ Parameters of a Proportional-Integral Active Power controller for a specified po
 - `ωz::Float64`: filter frequency cutoff, validation range: `(0, nothing)`
 - `P_ref::Float64`: (optional) Reference Power Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states of the ActivePowerPI model are:
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) of the ActivePowerPI model are:
 	σp_oc: Integrator state of the PI Controller,
 	p_oc: Measured active power of the inverter model
 - `n_states::Int`: (**Do not modify.**) ActivePowerPI has two states
@@ -39,7 +39,7 @@ mutable struct ActivePowerPI <: ActivePowerControl
     P_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states of the ActivePowerPI model are:
+    "(**Do not modify.**) The [states](@ref S) of the ActivePowerPI model are:
 	σp_oc: Integrator state of the PI Controller,
 	p_oc: Measured active power of the inverter model"
     states::Vector{Symbol}

src/models/generated/ActiveRenewableControllerAB.jl

@@ -32,7 +32,7 @@ This file is auto-generated. Do not edit.
 Parameters of Active Power Controller including REPCA1 and REECB1
 
 # Arguments
-- `bus_control::Int`: Bus Number for voltage control; , validation range: `(0, nothing)`
+- `bus_control::Int`: ACBus identification [`number`](@ref ACBus) for voltage control. `0` identifies the local bus connected to this component., validation range: `(0, nothing)`
 - `from_branch_control::Int`: Monitored branch FROM bus number for line drop compensation (if 0 generator power will be used), validation range: `(0, nothing)`
 - `to_branch_control::Int`: Monitored branch TO bus number for line drop compensation (if 0 generator power will be used), validation range: `(0, nothing)`
 - `branch_id_control::String`: Branch circuit id for line drop compensation (as a string). If 0 generator power will be used
@@ -51,11 +51,11 @@ Parameters of Active Power Controller including REPCA1 and REECB1
 - `T_pord::Float64`: Power filter time constant REECB time constant, validation range: `(0, nothing)`
 - `P_ref::Float64`: (optional) Reference Power Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states of the ActiveRenewableControllerAB model depends on the Flag
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) of the ActiveRenewableControllerAB model depends on the Flag
 - `n_states::Int`: (**Do not modify.**) The states of the ActiveRenewableControllerAB model depends on the Flag
 """
 mutable struct ActiveRenewableControllerAB <: ActivePowerControl
-    "Bus Number for voltage control; "
+    "ACBus identification [`number`](@ref ACBus) for voltage control. `0` identifies the local bus connected to this component."
     bus_control::Int
     "Monitored branch FROM bus number for line drop compensation (if 0 generator power will be used)"
     from_branch_control::Int
@@ -93,7 +93,7 @@ mutable struct ActiveRenewableControllerAB <: ActivePowerControl
     P_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states of the ActiveRenewableControllerAB model depends on the Flag"
+    "(**Do not modify.**) The [states](@ref S) of the ActiveRenewableControllerAB model depends on the Flag"
     states::Vector{Symbol}
     "(**Do not modify.**) The states of the ActiveRenewableControllerAB model depends on the Flag"
     n_states::Int

src/models/generated/ActiveVirtualOscillator.jl

@@ -14,14 +14,14 @@ This file is auto-generated. Do not edit.
         n_states::Int
     end
 
-Parameters of an Active Virtual Oscillator controller. Model is based from the paper Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control by O. Ajala et al.
+Parameters of an Active Virtual Oscillator controller. Model is based on ["Model Reduction for Inverters with Current Limiting and Dispatchable Virtual Oscillator Control."](https://doi.org/10.1109/TEC.2021.3083488)
 
 # Arguments
 - `k1::Float64`: VOC Synchronization Gain, validation range: `(0, nothing)`
 - `ψ::Float64`: Rotation angle of the controller, validation range: `(0, nothing)`
 - `P_ref::Float64`: (optional) Reference Power Set-point (pu), validation range: `(0, nothing)`
 - `ext::Dict{String, Any}`: (optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref).
-- `states::Vector{Symbol}`: (**Do not modify.**) The states of the ActiveVirtualOscillator model are:
+- `states::Vector{Symbol}`: (**Do not modify.**) The [states](@ref S) of the ActiveVirtualOscillator model are:
 	θ_oc: Phase angle displacement of the inverter model
 - `n_states::Int`: (**Do not modify.**) ActiveVirtualOscillator has one state
 """
@@ -34,7 +34,7 @@ mutable struct ActiveVirtualOscillator <: ActivePowerControl
     P_ref::Float64
     "(optional) An *ext*ra dictionary for users to add metadata that are not used in simulation, such as latitude and longitude. See [Adding additional fields](@ref)."
     ext::Dict{String, Any}
-    "(**Do not modify.**) The states of the ActiveVirtualOscillator model are:
+    "(**Do not modify.**) The [states](@ref S) of the ActiveVirtualOscillator model are:
 	θ_oc: Phase angle displacement of the inverter model"
     states::Vector{Symbol}
     "(**Do not modify.**) ActiveVirtualOscillator has one state"