Skip to content

DistOPF CSV Data Model

LinkML schema for the DistOPF three-phase distribution optimal power flow (OPF) CSV file format, enabling round-trip conversion with CIM. This schema is the single source of truth for both data structure and serialization formatting.

URI: https://gridappsd.org/cimhub/distopf

Name: distopf-schema

Classes

Class Description
BatteryRecord Battery energy storage system (BESS) data record for DistOPF
BranchRecord Branch data record for DistOPF
BusRecord Bus data record for DistOPF three-phase distribution OPF
CapacitorRecord Shunt capacitor data record for DistOPF
DistopfModel Complete DistOPF network model containing every record type in the CSV file s...
GeneratorRecord Generator (DER) data record for DistOPF
RegulatorRecord Step voltage regulator data record for DistOPF
ScheduleRecord Time-series schedule record for DistOPF

Slots

Slot Description
annual_cycle_limit Annual charge/discharge cycle limit, in cycles per year
battery_records Battery energy storage data records (bat_data
branch_records Branch data records for lines, switches, and transformers (branch_data
branch_type Branch element type (line, switch, or transformer)
bus_records Bus data records (bus_data
bus_type Bus type (SWING = slack bus, PQ = load bus)
capacitor_records Shunt capacitor data records (cap_data
charge_efficiency Charging efficiency, as a fraction (0
control_variable OPF control variable (P = active power, Q = reactive power, PQ = both, empty ...
cvr_p Conservation Voltage Reduction (CVR) active power coefficient
cvr_q Conservation Voltage Reduction (CVR) reactive power coefficient
default_multiplier Default load-shape multiplier for this hour (0
discharge_efficiency Discharging efficiency, as a fraction (0
energy_capacity Total energy capacity in per-unit hours (s_base × hour)
fb From-bus integer index
from_name From-bus name label (the ConnectivityNode name)
generator_records Generator (DER) data records (gen_data
generator_type Generator technology type (for example, pv or diesel)
has_cap True if a capacitor is connected at this bus
has_gen True if a generator is connected at this bus
has_load True if a load is connected at this bus
id Bus integer index (one-based row number)
latitude Geographic latitude, in degrees
length Branch length in meters (0
load_shape Name of the load-shape profile applied to this bus
longitude Geographic longitude, in degrees
max_soc Maximum state of charge, as a fraction (0
min_soc Minimum state of charge, as a fraction (0
name Bus name label (matches the original feeder bus number)
pa Phase A active power output in per-unit (base s_base)
pb Phase B active power output in per-unit (base s_base)
pc Phase C active power output in per-unit (base s_base)
phases Active phases at this bus (abc, a, b, c, ab, ac, bc)
pl_a Phase A active load in per-unit (base s_base)
pl_b Phase B active load in per-unit (base s_base)
pl_c Phase C active load in per-unit (base s_base)
price Locational marginal price for this hour, in $/MWh
pv_multiplier PV generation profile multiplier for this hour (0
qa Phase A reactive power output in per-unit (base s_base)
qa_max Phase A maximum reactive power in per-unit (base s_base)
qa_min Phase A minimum reactive power in per-unit (base s_base)
qb Phase B reactive power output in per-unit (base s_base)
qb_max Phase B maximum reactive power in per-unit (base s_base)
qb_min Phase B minimum reactive power in per-unit (base s_base)
qc Phase C reactive power output in per-unit (base s_base)
qc_max Phase C maximum reactive power in per-unit (base s_base)
qc_min Phase C minimum reactive power in per-unit (base s_base)
ql_a Phase A reactive load in per-unit (base s_base)
ql_b Phase B reactive load in per-unit (base s_base)
ql_c Phase C reactive load in per-unit (base s_base)
raa Resistance matrix element R_aa in per-unit (base z_base)
rab Resistance matrix element R_ab in per-unit (base z_base)
rac Resistance matrix element R_ac in per-unit (base z_base)
rbb Resistance matrix element R_bb in per-unit (base z_base)
rbc Resistance matrix element R_bc in per-unit (base z_base)
rcc Resistance matrix element R_cc in per-unit (base z_base)
regulator_records Voltage regulator tap-position records (reg_data
s_base Apparent power base, in volt-amperes
s_max Maximum apparent power rating in per-unit (base s_base)
sa_max Phase A apparent power limit in per-unit (base s_base)
sb_max Phase B apparent power limit in per-unit (base s_base)
sc_max Phase C apparent power limit in per-unit (base s_base)
schedule_records Time-series load/PV shape and price records (schedules
start_soc Initial state of charge, as a fraction (0
status Switch status (CLOSED, OPEN, or empty for non-switching elements)
tap_a Phase A tap position, in steps (0
tap_b Phase B tap position, in steps (0
tap_c Phase C tap position, in steps (0
tb To-bus integer index
time Hour index (zero-based integer time step)
to_name To-bus name label (the ConnectivityNode name)
v_a Phase A initial voltage magnitude in per-unit (base v_ln_base)
v_b Phase B initial voltage magnitude in per-unit (base v_ln_base)
v_c Phase C initial voltage magnitude in per-unit (base v_ln_base)
v_ln_base Line-to-neutral base voltage, in volts
v_max Maximum voltage magnitude limit, in per-unit
v_min Minimum voltage magnitude limit, in per-unit
xaa Reactance matrix element X_aa in per-unit (base z_base)
xab Reactance matrix element X_ab in per-unit (base z_base)
xac Reactance matrix element X_ac in per-unit (base z_base)
xbb Reactance matrix element X_bb in per-unit (base z_base)
xbc Reactance matrix element X_bc in per-unit (base z_base)
xcc Reactance matrix element X_cc in per-unit (base z_base)
z_base Impedance base in ohms (z_base = v_ln_base² / s_base)

Enumerations

Enumeration Description

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description