Models Catalog

r2x_sienna.models provides the component classes used for parse and export.

Topology

  • Area, LoadZone

  • Bus, ACBus, DCBus

  • Arc

Bus, ACBus, and DCBus represent network nodes; Arc is the topology relationship used by branch and network equipment models.

Branch and Network Equipment

  • Branch, ACBranch, DCBranch

  • Line, MonitoredLine

  • TwoWindingTransformer, ThreeWindingTransformer

  • Transformer2W, TapTransformer, PhaseShiftingTransformer

  • Transformer3W, PhaseShiftingTransformer3W

  • TwoTerminalHVDCLine, TwoTerminalGenericHVDCLine, TwoTerminalLCCLine, TwoTerminalVSCLine, TModelHVDCLine

  • AreaInterchange, DiscreteControlledACBranch

Generation and Storage

  • Generator, Source, SynchronousCondenser, HybridSystem

  • Thermal: ThermalGen, ThermalStandard, ThermalMultiStart

  • Hydro: HydroGen, HydroDispatch, HydroReservoir, HydroEnergyReservoir, HydroPumpedStorage, HydroPumpTurbine, HydroTurbine

  • Renewable: RenewableGen, RenewableDispatch, RenewableNonDispatch

  • Storage: Storage, EnergyReservoirStorage

Load and FACTS-adjacent Load Models

  • InterconnectingConverter

  • PowerLoad, StandardLoad, InterruptiblePowerLoad, InterruptibleStandardLoad

  • ShiftablePowerLoad

  • MotorLoad, ExponentialLoad

  • ActiveConstantPowerLoad

  • FixedAdmittance, SwitchedAdmittance, FACTSControlDevice

Services and Core Mappings

  • Service

  • Reserve, VariableReserve

  • ReserveNonSpinning, VariableReserveNonSpinning, ConstantReserveNonSpinning

  • ReserveDemandCurve, TransmissionInterface

  • ReserveMap, TransmissionInterfaceMap

Cost Models

  • ThermalGenerationCost

  • HydroGenerationCost, HydroReservoirCost

  • RenewableGenerationCost

  • StorageCost

  • LoadCost

Supplemental Attributes

  • GeographicInfo

  • GeometricDistributionForcedOutage

  • ImpedanceCorrectionData

  • EmissionsData — emission rate (as a ValueCurve) for a single pollutant; attach to any component via add_supplemental_attribute. Supports FUEL_INPUT or POWER_OUTPUT basis with validated energy_unit pairing. Scalar float rates are automatically wrapped in a constant-rate LinearCurve.

All Exported Models

The following classes and model-like types are exported from r2x_sienna.models and are available for direct import. The grouped catalog above describes their domain roles; this list is the complete public export surface for model definitions.

Component Classes

ACBranch, ACBus, ActiveConstantPowerLoad, Arc, Area, AreaInterchange, Branch, Bus, ConstantReserveNonSpinning, DCBranch, DCBus, DiscreteControlledACBranch, EmissionsData, EnergyReservoirStorage, ExponentialLoad, FACTSControlDevice, FixedAdmittance, Generator, GeographicInfo, GeometricDistributionForcedOutage, HybridSystem, HydroDispatch, HydroEnergyReservoir, HydroGen, HydroGenerationCost, HydroPumpTurbine, HydroPumpedStorage, HydroReservoir, HydroReservoirCost, HydroTurbine, ImpedanceCorrectionData, InterconnectingConverter, InterruptiblePowerLoad, InterruptibleStandardLoad, Line, LoadCost, LoadZone, MonitoredLine, MotorLoad, PhaseShiftingTransformer, PhaseShiftingTransformer3W, PowerLoad, RenewableDispatch, RenewableGen, RenewableGenerationCost, RenewableNonDispatch, Reserve, ReserveDemandCurve, ReserveMap, ReserveNonSpinning, Service, ShiftablePowerLoad, Source, StandardLoad, Storage, StorageCost, SwitchedAdmittance, SynchronousCondenser, TModelHVDCLine, TapTransformer, ThermalGen, ThermalGenerationCost, ThermalMultiStart, ThermalStandard, ThreeWindingTransformer, TransmissionInterface, TransmissionInterfaceMap, TwoTerminalGenericHVDCLine, TwoTerminalHVDCLine, TwoTerminalLCCLine, TwoTerminalVSCLine, TwoWindingTransformer, Transformer2W, Transformer3W, VariableReserve, and VariableReserveNonSpinning.

Emissions Enums

Enum

Members

PollutantType

CO2, CO2E, CH4, N2O, NOX, SO2, PM25, PM10, HG, HAP, CUSTOM

EmissionBasis

FUEL_INPUT, POWER_OUTPUT

MassUnit

KG, LB, SHORT_TON, METRIC_TON

EnergyUnit

MMBTU, GJ, MWH

Additional exported classification enums are:

  • ACBusTypes

  • DiscreteControlledBranchStatus, DiscreteControlledBranchType

  • FACTSOperationModes

  • HydroTurbineType, PumpHydroStatus, ReservoirDataType, ReservoirLocation

  • ImpedanceCorrectionTransformerControlMode

  • PrimeMoversType, ReserveDirection, ReserveType

  • ThermalFuels

  • TransformerControlObjective

  • WindingCategory, WindingGroupNumber

Helper Types and Enums

  • Named tuples/helpers: MinMax, UpDown, StartShut, StartUpStages, StartTimeLimits, InputOutput, FromTo_ToFrom, Complex, GeoLocation

  • Enums include fuel, reserve, transformer, hydro, bus-type, and related classification values

These helper models are used as typed fields inside component and cost models; they can also be imported directly from r2x_sienna.models.

Notes

  • Models are strongly typed and validated via pydantic.

  • Base component classes include per-unit-aware behavior and shared serialization patterns.

  • The parser relies on model metadata to resolve component references and deserialize polymorphic types.

PSY Compatibility Highlights

Recent model updates align r2x_sienna.models with current PowerSystems.jl generated schemas for overlapping component names.

  • Thermal cost: ThermalGenerationCost.start_up accepts either scalar or staged startup values (StartUpStages).

  • AC branch flows: Line and MonitoredLine active/reactive flow fields accept signed values.

  • Line requirements: Line enforces required electrical fields (r, x, rating) for PSY-style construction.

  • Static injection linkage: static-injection models support optional dynamic_injector linkage to dynamic models.

  • Load conformity naming: load models use canonical conformity; legacy input key comformity remains accepted as an alias.

  • FACTS and switched-admittance controls: control/regulated-bus/reactive-limit fields are represented in FACTSControlDevice and SwitchedAdmittance.

  • HVDC and converter controls: VSC and converter control fields (setpoints, control modes, droop, remote bus control metadata) are modeled for PSY interoperability.

  • T-model HVDC representation: PSY-style r, l, c, active flow, and directional active-power limits are available in TModelHVDCLine.

  • Interface services: TransmissionInterface includes violation_penalty.

These updates are additive where possible and preserve existing parse/export behavior expected by r2x-sienna users.