Crate ctm

The Common Electric Power Transmission System Model (CTM) is an intuitive, extensible, language-agnostic, and range-validating spefication of electric power network components’ parameter names and units, and the relation between components, intended for use by the research community developing new computational methods for power systems operations and simulation.

This standard data structure in CTM makes it easy to work in multiple power systems domains (e.g., economic operation, reliability assessment, electricity markets, stability assessment) without requiring conversions between use-case-specific file formats and data structures with information loss in the process.

Modules

builder

Types for composing complex structures.

defaults

Generation of default values for serde.

error

Error types.

Structs

Binary

binary

Ctm

Common Transmission Model (CTM) Data Schema v0.1

CtmNetwork

structure to hold persistent network data

CtmNetworkAcLineItem

structure to hold ac line data using concentrated (6-parameter circuit) PI model

CtmNetworkAreaItem

geographical subset of the electrical network with common Automatic Generation Control (AGC) and responsible for its Area Control Error (ACE)

CtmNetworkBusItem

structure to hold bus data

CtmNetworkGenItem

structure to hold generator data

CtmNetworkGlobalParams

structure to hold global settings for parameters in the network

CtmNetworkHvdcP2pItem

structure to hold point-to-point hvdc line data

CtmNetworkLoadItem

structure to hold load (consumer) data using ZIP model

CtmNetworkReserveItem

structure to hold reserve product and requirement data

CtmNetworkShuntItem

structure to hold shunt data

CtmNetworkStorageItem

structure to hold storage (battery) data

CtmNetworkSwitchItem

CtmNetworkSwitchItem

CtmNetworkTransformerItem

structure to hold 2-winding transformer and phase shifter data using simplified (4-parameter circuit) model

CtmNetworkZoneItem

geographical subset of the electrical network commonly associated with market purposes (e.g., define sub-markets within a large interconnected system, defining different areas for reserve products, etc.)

CtmTemporalBoundary

structure to hold data on initial conditions of power system (state prior to start of time series data)

CtmTemporalBoundaryBusItem

structure to hold initial state of bus variables

CtmTemporalBoundaryGenItem

structure to hold initial state of generator variables

CtmTemporalBoundaryGlobalParams

structure to hold global parameters of temporal boundary

CtmTemporalBoundaryHvdcP2pItem

structure to hold initial state of hvdc point-to-point line variables

CtmTemporalBoundaryShuntItem

structure to hold initial state of shunt variables

CtmTemporalBoundaryStorageItem

structure to hold initial state of storage variables

CtmTemporalBoundarySwitchItem

structure to hold initial state of switch variables

CtmTemporalBoundaryTransformerItem

structure to hold initial state of transformer variables

CtmTimeSeriesData

structure to contain all time variant data of the system/case. All time series are synchronized to the same timestamps, which should should be stored using Unix time. Structure is quasi-tabular, with uid, name, path_to_file, values, and ext being arrays in the same order of said field. This is done in order to allow for better compression (e.g., using HDF5) for the values field.

NonnegativeInteger

nonnegative integer number

NonnegativeNumber

NonnegativeNumber

PositiveInteger

positive integer number

PositiveNumber

PositiveNumber

Status

binary indicator of whether component should be included or omitted; 1=>included, 0=>omitted

TimeSeriesReference

structure to hold a reference (possibly, to be scaled) to a time series

XyPairs

pairs of data points saved as two vectors (of the same length)

Enums

CtmNetworkAcLineItemCmUbA

[kA or pu] persistent current rating

CtmNetworkAcLineItemCmUbB

[kA or pu] 4-hour current rating

CtmNetworkAcLineItemCmUbC

[kA or pu] 15-minute current rating

CtmNetworkAcLineItemSmUbA

[MVA or pu] persistent apparent power rating

CtmNetworkAcLineItemSmUbB

[MVA or pu] 4-hour apparent power rating

CtmNetworkAcLineItemSmUbC

[MVA or pu] 15-minute apparent power rating

CtmNetworkBusItemType

bus type for power flow calculations (PV, PQ, or slack)

CtmNetworkBusItemTypeVariant0

CtmNetworkBusItemTypeVariant0

CtmNetworkBusItemVmLb

bus voltage lower bound

CtmNetworkBusItemVmUb

bus voltage upper bound

CtmNetworkGenItemCostPgModel

type of generation cost model (i.e., function translating power/energy to money); POLYNOMIAL => cost_pg_parameters is an array with n+1 coefficients <a_i> for f(x) = a_0 + a_1 x^1 + … + a_n x^n; PIECEWISE_LINEAR => cost_pg_parameters is a series of values <x_i, f_i> and cost (f) should be interpolated linearly in between points; MARGINAL_COST => cost_pg_parameters is a series of values <b_i, m_i>, where m_i is a marginal cost ($/MWh or $/(puh)) and b_i is the amoung of power (MWh or puh) sold at marginal cost m_i

CtmNetworkGenItemCostPgParameters

parameters of generation cost function, can be time dependent

CtmNetworkGenItemPgLb

[MW or pu] lower bound of active power injection (rectangular operating zone)

CtmNetworkGenItemPgUb

[MW or pu] upper bound of active power injection (rectangular operating zone)

CtmNetworkGenItemPrimarySource

primary energy source

CtmNetworkGenItemPrimarySourceSubtype

subtype of primary energy source; thermal classification taken from https://www.eia.gov/survey/form/eia_923/instructions.pdf

CtmNetworkGenItemQgLb

[MVAr or pu] lower bound of reactive power injection (rectangular operating zone)

CtmNetworkGenItemQgUb

[MVAr or pu] upper bound of reactive power injection (rectangular operating zone)

CtmNetworkGenItemServiceRequired

whether generator must be in service (e.g., nuclear power plant) or out of service (e.g., generator during maintenance or after an outage); 0 => no requirement, 1 => fixed in service, 2 => fixed out of service

CtmNetworkGenItemShutdownCost

[$] cost of shutting down the unit

CtmNetworkGenItemStartupCostCold

[$] cost of starting the unit after being off > startup_time_warm hours

CtmNetworkGenItemStartupCostHot

[$] cost of starting the unit after being off <= startup_time_hot hours

CtmNetworkGenItemStartupCostWarm

[$] cost of starting the unit after being off > startup_time_hot hours, but <= startup_time_warm hours

CtmNetworkGenItemVmSetpoint

[kV or pu] target voltage magnitude of the bus that this generator connects to

CtmNetworkGlobalParamsUnitConvention

units used for physical network parameters

CtmNetworkHvdcP2pItemCmUbFr

[kA or pu] ac persistent current rating, from terminal (if in pu, use from bus base_kv)

CtmNetworkHvdcP2pItemCmUbTo

[kA or pu] ac persistent current rating, to terminal (if in pu, use to bus base_kv)

CtmNetworkHvdcP2pItemPdcFrLb

[MW or pu] minimum active power entering hvdc line at from bus

CtmNetworkHvdcP2pItemPdcFrUb

[MW or pu] maximum active power entering hvdc line at from bus

CtmNetworkHvdcP2pItemPdcToLb

[MW or pu] minimum active power entering hvdc line at to bus

CtmNetworkHvdcP2pItemPdcToUb

[MW or pu] maximum active power entering hvdc line at to bus

CtmNetworkHvdcP2pItemQdcFrLb

[MVAr or pu] minimum reactive power entering hvdc line at from bus

CtmNetworkHvdcP2pItemQdcFrUb

[MVAr or pu] maximum reactive power entering hvdc line at from bus

CtmNetworkHvdcP2pItemQdcToLb

[MVAr or pu] minimum reactive power entering hvdc line at to bus

CtmNetworkHvdcP2pItemQdcToUb

[MW or pu] maximum active power entering hvdc line at to bus

CtmNetworkHvdcP2pItemSmUb

[MVA or pu] ac persistent apparent power rating

CtmNetworkHvdcP2pItemTechnology

power conversion technology

CtmNetworkLoadItemPd

active power demand

CtmNetworkLoadItemPdI

constant current active power demand at v_bus = 1.0 pu

CtmNetworkLoadItemPdY

constant impedance active power demand at v_bus = 1.0 pu

CtmNetworkLoadItemQd

reactive power demand

CtmNetworkLoadItemQdI

constant current reactive power demand at v_bus = 1.0 pu

CtmNetworkLoadItemQdY

constant impedance reactive power demand at v_bus = 1.0 pu

CtmNetworkReserveItemPgDown

[MW or pu] downward active power required by this reserve

CtmNetworkReserveItemPgUp

[MW or pu] upward active power required by this reserve

CtmNetworkReserveItemReserveType

CtmNetworkReserveItemReserveType

CtmNetworkShuntItemBs

[MVAr or pu] reactive power demand at v_bus = 1.0 pu, per step of each shunt section

CtmNetworkShuntItemGs

[MW or pu] active power demand at v_bus = 1.0 pu, per step of each shunt section

CtmNetworkShuntItemNumStepsUb

upper bound for number of energized steps of shunt section (lower bound is always 0)

CtmNetworkStorageItemChargeEfficiency

[-] charge efficiency, in (0, 1]

CtmNetworkStorageItemChargeUb

[MW or pu] maximum rate of charge

CtmNetworkStorageItemDischargeEfficiency

[-] discharge efficiency, in (0, 1]

CtmNetworkStorageItemDischargeUb

[MW or pu] maximum rate of discharge

CtmNetworkStorageItemQsLb

[MVAr or pu] minumum reactive power injection

CtmNetworkStorageItemQsUb

[MVAr or pu] maximum reactive power injection

CtmNetworkTransformerItemCmUbA

[kA or pu] persistent current rating, referred to from side

CtmNetworkTransformerItemCmUbB

[kA or pu] 4-hour current rating, referred to from side

CtmNetworkTransformerItemCmUbC

[kA or pu] 15-minute current rating, referred to from side

CtmNetworkTransformerItemSmUbA

[MVA or pu] persistent apparent power rating, referred to from side

CtmNetworkTransformerItemSmUbB

[MVA or pu] 4-hour apparent power rating, referred to from side

CtmNetworkTransformerItemSmUbC

[MVA or pu] 15-minute apparent power rating, referred to from side

CtmTemporalBoundaryShuntItemNumSteps

[-] number of initial energized steps per section

CtmTimeSeriesDataPathToFile

path to file containing all time series information or a separate path for each time series

TimeSeriesReferenceUid

uid of time series (in time_series_data) this reference points to

Uid

object’s Unique IDentifier