Skip to content

PLEXOS to Sienna Property Mappings

This page documents the property-level mappings used by r2x-plexos-to-sienna. The class mappings are summarized in PLEXOS to Sienna. This page explains how fields are copied or computed after the target class is selected.

The authoritative source is the rules.json file. In the tables below, field map means a direct source-to-target field copy and getter means a computed value supplied by a translation helper.

PLEXOS generator categories are resolved by get_gen_technology_class; matching rules select the Sienna class. The selected rule combines direct identity fields, defaults and computed properties. The groups below summarize the target families, not an unconditional expansion of one generator into every displayed class.

flowchart LR
  accTitle: PLEXOS generator family selection
  accDescr: PLEXOSGenerator is classified by get_gen_technology_class. Thermal, hydro, renewable or condenser matching rules select the corresponding Sienna class. Tables specify the properties for each target.
  G["PLEXOSGenerator"] --> C{"get_gen_technology_class"}
  C -->|"thermal / thermal-multi-start"| T["ThermalStandard<br/>ThermalMultiStart"]
  C -->|"hydro-dispatch / hydro-turbine"| H["HydroDispatch<br/>HydroTurbine"]
  C -->|"renewable-dispatch / renewable-non-dispatch"| R["RenewableDispatch<br/>RenewableNonDispatch"]
  C -->|"synchronous-condenser"| S["SynchronousCondenser"]
  class G source
  class C process
  class T,H,R,S target
  classDef source fill:#d9effa,stroke:#0079c2,color:#003a69,stroke-width:2px
  classDef process fill:#f4f7f9,stroke:#7890a0,color:#293d4d
  classDef target fill:#003a69,stroke:#0079c2,color:#ffffff,stroke-width:2px

Within each grouped node, the class matches the corresponding classification value in the same order. Generator limits, costs, bus references and services come from getters; they are not all direct field copies.

PLEXOSRegion and PLEXOSPurchaser have separate rules that produce PowerLoad. Their getters resolve target bus references through source memberships and compute load properties. Node load time series are attached to target loads under the active_power name by the translation helpers.

flowchart LR
  accTitle: PLEXOS load property conversion
  accDescr: Separate PLEXOSRegion and PLEXOSPurchaser rules map identity fields and compute bus and power properties for PowerLoad. Memberships resolve bus references; helpers attach renamed active_power time series.
  R["PLEXOSRegion"] --> M["Map identity<br/>Resolve memberships<br/>Compute load properties"]
  P["PLEXOSPurchaser"] --> M
  M --> L["PowerLoad<br/>bus, active_power<br/>max_active_power + base_power"]
  class R,P source
  class M process
  class L target
  classDef source fill:#d9effa,stroke:#0079c2,color:#003a69,stroke-width:2px
  classDef process fill:#f4f7f9,stroke:#7890a0,color:#293d4d
  classDef target fill:#003a69,stroke:#0079c2,color:#ffffff,stroke-width:2px
Source propertyTarget propertyMapping
namenamefield map
uuiduuidfield map
categorycategoryfield map or target default
PLEXOS availability/unitsavailable or unitsgetter or field map
Source classTarget classDirect fieldsComputed properties
PLEXOSZoneLoadZonename, category, uuidpeak_active_power, peak_reactive_power
PLEXOSNodeACBusname, uuid, categorynumber, base_voltage, magnitude, bustype, area, load_zone, angle, ext
PLEXOSRegionPowerLoadname, uuid, categorybus, active_power, reactive_power, max_active_power, max_reactive_power, base_power
PLEXOSPurchaserPowerLoadname, uuid, categorybus, active_power, available, max_active_power, reactive_power, max_reactive_power, base_power
PLEXOSRegionAreaname, categoryload_response, peak_active_power, peak_reactive_power

Node-to-region and purchaser-to-node memberships are used by the getters to resolve the target bus. A node’s load time series is renamed to the target load’s active_power time series.

Selected Sienna classDirect fieldsComputed properties
ThermalStandardname, uuid, category, ratingactive_power, active_power_limits, available, base_power, bus, fuel, must_run, operation_cost, prime_mover_type, ramp_limits, reactive_power, reactive_power_limits, services, status, time_at_status, time_limits
ThermalMultiStartname, uuid, category, ratingThermal properties plus start_types
HydroDispatchname, uuid, category, ratingactive_power, active_power_limits, base_power, bus, operation_cost, prime_mover_type, ramp_limits, reactive_power, reactive_power_limits, services, status, time_at_status, time_limits
HydroTurbinename, uuid, category, ratingactive_power, active_power_limits, base_power, bus, operation_cost, prime_mover_type, ramp_limits, reactive_power, reactive_power_limits, services, time_limits
RenewableDispatchname, uuid, category, ratingactive_power, base_power, bus, operation_cost, power_factor, prime_mover_type, reactive_power, reactive_power_limits, services
RenewableNonDispatchname, uuid, category, ratingactive_power, base_power, bus, power_factor, prime_mover_type, reactive_power, services
SynchronousCondensername, uuid, category, ratingactive_power_losses, base_power, bus, reactive_power, reactive_power_limits, services

Generator category selects the row family; see the category diagram and family details in PLEXOS to Sienna.

Source classTarget classProperty highlights
PLEXOSReserveVariableReservetime_frame, requirement, reserve_type, direction, sustained_time, participation, deployment fractions
PLEXOSLineLine / MonitoredLine / TwoTerminalGenericHVDCLineactive_power_flow, ratings, resistance, reactance, arcs, flow_limits, losses
PLEXOSTransformerTransformer2W / TapTransformer / PhaseShiftingTransformerresistance, reactance, rating, tap, control_objective, shunt, winding_group
PLEXOSInterfaceTransmissionInterfaceflow_limits, availability, direction mapping
PLEXOSBatteryEnergyReservoirStoragepower_limits, efficiency, SOC, storage capacity/target, technology, bus, services
PLEXOSStorageHydroReservoirinitial_level, bus, operation_cost, services

Target defaults such as category="power-load", category="node", and category="line" are applied by the rules when the source does not provide a compatible value. Category filters distinguish monitored lines, HVDC lines, and transformer variants.