Data types - OEDI-SI

Components exchange typed values defined as Pydantic models in oedisi.types.data_types. A port’s type in a component_definition.json refers to one of the models below. Many concrete types are thin subclasses that inherit their fields from a base array type.

Summary¶

Type	Inherits
`StateArray`	`BaseModel`
`SwitchStates`	`StateArray`
`CapacitorStates`	`StateArray`
`RegulatorStates`	`StateArray`
`CostArray`	`BaseModel`
`RealCostFunctions`	`CostArray`
`ReactiveCostFunctions`	`CostArray`
`RealWholesalePrices`	`CostArray`
`ReactiveWholesalePrices`	`CostArray`
`OperationalCosts`	`CostArray`
`MeasurementArray`	`BaseModel`
`BusArray`	`MeasurementArray`
`EquipmentArray`	`MeasurementArray`
`EquipmentNodeArray`	`MeasurementArray`
`VoltagesMagnitude`	`BusArray`
`VoltagesAngle`	`BusArray`
`VoltagesReal`	`BusArray`
`VoltagesImaginary`	`BusArray`
`CurrentsMagnitude`	`EquipmentArray`
`CurrentsAngle`	`EquipmentArray`
`CurrentsReal`	`EquipmentArray`
`CurrentsImaginary`	`EquipmentArray`
`ImpedanceReal`	`EquipmentArray`
`ImpedanceImaginary`	`EquipmentArray`
`ImpedanceMagnitude`	`EquipmentArray`
`ImpedanceAngle`	`EquipmentArray`
`PowersMagnitude`	`EquipmentNodeArray`
`PowersAngle`	`EquipmentNodeArray`
`PowersReal`	`EquipmentNodeArray`
`PowersImaginary`	`EquipmentNodeArray`
`SolarIrradiances`	`EquipmentArray`
`Temperatures`	`EquipmentArray`
`WindSpeeds`	`EquipmentArray`
`StatesOfCharge`	`EquipmentArray`
`Topology`	`BaseModel`
`Incidence`	`BaseModel`
`IncidenceList`	`Incidence`
`AdmittanceSparse`	`Incidence`
`AdmittanceMatrix`	`BaseModel`
`Injection`	`BaseModel`
`Command`	`BaseModel`
`CommandList`	`RootModel`
`VVControl`	`BaseModel`
`VWControl`	`BaseModel`
`InverterControl`	`BaseModel`
`InverterControlList`	`RootModel`

StateArray¶

Inherits BaseModel.

Base class for power system equipment state arrays.

Extended by classes: “SwitchStates”, “CapacitorStates”, “RegulatorStates”.

Fields

Field	Type	Default
`values`	`list[int]`	required
`ids`	`list[str]`	required
`time`	`datetime \| None`	`None`

SwitchStates¶

Inherits StateArray.

Switch state data for power system equipment.

CapacitorStates¶

Inherits StateArray.

Capacitor state data for power system equipment.

RegulatorStates¶

Inherits StateArray.

Voltage regulator state data for power system equipment.

CostArray¶

Inherits BaseModel.

Base class for cost-related data arrays.

Extended by classes: “RealCostFunctions”, “ReactiveCostFunctions”, “RealWholesalePrices”, “ReactiveWholesalePrices”, “OperationalCosts”.

Fields

Field	Type	Default
`values`	`list[list[float]]`	required
`ids`	`list[str]`	required
`units`	`str`	`'$'`
`time`	`datetime \| None`	`None`

RealCostFunctions¶

Inherits CostArray.

Real power cost functions for equipment.

ReactiveCostFunctions¶

Inherits CostArray.

Reactive power cost functions for equipment.

RealWholesalePrices¶

Inherits CostArray.

Real power wholesale price data for equipment.

ReactiveWholesalePrices¶

Inherits CostArray.

Reactive power wholesale price data for equipment.

OperationalCosts¶

Inherits CostArray.

Operational cost data for equipment.

MeasurementArray¶

Inherits BaseModel.

Base class for measurement data arrays.

Extended by classes: “BusArray”, “EquipmentArray”, “EquipmentNodeArray”.

Fields

Field	Type	Default
`values`	`list[float]`	required
`ids`	`list[str]`	required
`units`	`str`	required
`accuracy`	`list[float] \| None`	`None`
`bad_data_threshold`	`list[float] \| None`	`None`
`time`	`datetime \| None`	`None`

BusArray¶

Inherits MeasurementArray.

Measurements for or at power system buses (primarily voltages).

EquipmentArray¶

Inherits MeasurementArray.

Measurements at equipment nodes (currents, impedances, environmental).

EquipmentNodeArray¶

Inherits MeasurementArray.

Power measurements at equipment nodes (primary key: ids + equipment_ids).

Primary key is ids + equipment_ids where ids correspond to node ids (e.g., “113.1”, “113.2”, “113.3”) and equipment_ids correspond to equipment identifiers (e.g., PVSystem.113).

Fields

Field	Type	Default	Description
`equipment_ids`	`list[str]`	required

VoltagesMagnitude¶

Inherits BusArray.

Voltage magnitude measurements at buses.

VoltagesAngle¶

Inherits BusArray.

Voltage angle measurements at buses.

VoltagesReal¶

Inherits BusArray.

Real component of voltage measurements at buses.

VoltagesImaginary¶

Inherits BusArray.

Imaginary component of voltage measurements at buses.

CurrentsMagnitude¶

Inherits EquipmentArray.

Current magnitude measurements at equipment.

CurrentsAngle¶

Inherits EquipmentArray.

Current angle measurements at equipment.

CurrentsReal¶

Inherits EquipmentArray.

Real component of current measurements at equipment.

CurrentsImaginary¶

Inherits EquipmentArray.

Imaginary component of current measurements at equipment.

ImpedanceReal¶

Inherits EquipmentArray.

Real component of impedance measurements at equipment.

ImpedanceImaginary¶

Inherits EquipmentArray.

Imaginary component of impedance measurements at equipment.

ImpedanceMagnitude¶

Inherits EquipmentArray.

Impedance magnitude measurements at equipment.

ImpedanceAngle¶

Inherits EquipmentArray.

Impedance angle measurements at equipment.

PowersMagnitude¶

Inherits EquipmentNodeArray.

Power magnitude (apparent power) measurements at equipment nodes.

PowersAngle¶

Inherits EquipmentNodeArray.

Power angle measurements at equipment nodes.

PowersReal¶

Inherits EquipmentNodeArray.

Real power measurements at equipment nodes.

PowersImaginary¶

Inherits EquipmentNodeArray.

Reactive power measurements at equipment nodes.

SolarIrradiances¶

Inherits EquipmentArray.

Solar irradiance measurements at equipment.

Temperatures¶

Inherits EquipmentArray.

Temperature measurements at equipment.

WindSpeeds¶

Inherits EquipmentArray.

Wind speed measurements at equipment.

StatesOfCharge¶

Inherits EquipmentArray.

State of charge measurements for energy storage equipment.

Topology¶

Inherits BaseModel.

Power system network topology with admittance and injection data.

Fields

Field	Type	Default
`admittance`	`AdmittanceSparse \| AdmittanceMatrix`	required
`injections`	`Injection`	required
`incidences`	`IncidenceList \| None`	`None`
`base_voltage_angles`	`VoltagesAngle \| None`	`None`
`base_voltage_magnitudes`	`VoltagesMagnitude \| None`	`None`
`slack_bus`	`list[str]`	`[]`

Incidence¶

Inherits BaseModel.

Incidence relationships between equipment in the power system.

Each list should have the same length. 3W transformers are transformed into 2 separate edges.

Fields

Field	Type	Default
`from_equipment`	`list[str]`	required
`to_equipment`	`list[str]`	required
`equipment_type`	`list[str] \| None`	`None`

IncidenceList¶

Inherits Incidence.

Incidence relationships with associated identifiers.

Fields

Field	Type	Default	Description
`ids`	`list[str]`	required

AdmittanceSparse¶

Inherits Incidence.

Sparse representation of network admittance matrix.

Fields

Field	Type	Default	Description
`admittance_list`	`list[tuple[float, float]]`	required
`units`	`str`	`'S'`

AdmittanceMatrix¶

Inherits BaseModel.

Dense representation of network admittance matrix.

Fields

Field	Type	Default
`admittance_matrix`	`list[list[tuple[float, float]]]`	required
`ids`	`list[str]`	required
`units`	`str`	`'S'`

Injection¶

Inherits BaseModel.

Current and power injections at network nodes.

Fields

Field	Type	Default	Description
`current_real`	`CurrentsReal`	`PydanticUndefined`	Fixed real current injections
`current_imaginary`	`CurrentsImaginary`	`PydanticUndefined`	Fixed imaginary current injections
`power_real`	`PowersReal`	`PydanticUndefined`	Fixed real power injections
`power_imaginary`	`PowersImaginary`	`PydanticUndefined`	Fixed imaginary power injections
`impedance_real`	`ImpedanceReal`	`PydanticUndefined`	Fixed real impedances
`impedance_imaginary`	`ImpedanceImaginary`	`PydanticUndefined`	Fixed imaginary impedances

Command¶

Inherits BaseModel.

JSON Configuration for external object commands for OpenDSS.

Fields

Field	Type	Default
`obj_name`	`str`	required
`obj_property`	`str`	required
`val`	`str`	required

CommandList¶

Inherits RootModel.

A list wrapper around list[Command].

VVControl¶

Inherits BaseModel.

OpenDSS setting for volt-var control.

Fields

Field	Type	Default
`deltaq_factor`	`float`	`-1.0`
`varchangetolerance`	`float`	`0.025`
`voltagechangetolerance`	`float`	`0.0001`
`vv_refreactivepower`	`<enum 'ReactivePowerSetting'>`	`<ReactivePowerSetting.VARAVAL_WATTS: 'VARAVAL_WATTS'>`
`voltage`	`list[float]`	required
`reactive_response`	`list[float]`	required

VWControl¶

Inherits BaseModel.

OpenDSS setting for volt-watt control.

See https://dss-extensions.org/dss-format/InvControl.html.

Fields

Field	Type	Default
`deltap_factor`	`float`	`-1.0`
`voltage`	`list[float]`	required
`power_response`	`list[float]`	required

InverterControl¶

Inherits BaseModel.

InverterControl with volt-var control and/or volt-watt control.

See https://dss-extensions.org/dss-format/InvControl.html.

Fields

Field	Type	Default
`pvsystem_list`	`list[str] \| None`	`None`
`vvcontrol`	`VVControl \| None`	`None`
`vwcontrol`	`VWControl \| None`	`None`
`mode`	`<enum 'InverterControlMode'>`	`<InverterControlMode.voltvar: 'VOLTVAR'>`

InverterControlList¶

Inherits RootModel.

A list wrapper around list[InverterControl].