API Reference

Bus <: AbstractComponent

Structure representing a bus (node) in power systems.

Fields

• index::Int: Unique identifier for the bus
• name::String: Bus name
• vn_kv::Float64: Nominal voltage level in kV
• max_vm_pu::Float64: Maximum voltage magnitude in per unit
• min_vm_pu::Float64: Minimum voltage magnitude in per unit
• in_service::Bool: Operating status flag
• bus_id::Int: Bus identifier
• area_id::Int: Area identifier the bus belongs to
• zone_id::Int: Zone identifier the bus belongs to

BusDC <: AbstractComponent

Represents a DC bus (node) in a power system network.

Fields

• index::Int: Unique identifier for the bus
• name::String: Name of the bus
• vn_kv::Float64: Nominal voltage in kilovolts
• max_vm_pu::Float64: Maximum allowed voltage magnitude in per unit
• min_vm_pu::Float64: Minimum allowed voltage magnitude in per unit
• in_service::Bool: Operational status (true if in service)
• bus_id::Int: External bus identifier
• area_id::Int: Area identifier the bus belongs to
• zone_id::Int: Zone identifier the bus belongs to

ACPVSystem <: AbstractComponent

Structure representing an AC photovoltaic system, including PV module and inverter parameters.

Fields

• index::Int: Unique identifier for the PV system
• name::String: PV system name
• bus::Int: Connected bus number
• p_mw::Float64: Active power output (MW)
• q_mvar::Float64: Reactive power output (MVar)
• vm_ac_pu::Float64: AC-side voltage magnitude (per unit)
• vm_dc_pu::Float64: DC-side voltage magnitude (per unit)
• loss_percent::Float64: Loss percentage
• loss_mw::Float64: Power loss (MW)
• max_p_mw::Float64: Maximum active power limit (MW)
• min_p_mw::Float64: Minimum active power limit (MW)
• max_q_mvar::Float64: Maximum reactive power limit (MVar)
• min_q_mvar::Float64: Minimum reactive power limit (MVar)
• numpanelseries::Int: Number of panels in series
• numpanelparallel::Int: Number of panels in parallel
• vmpp::Float64: Maximum power point voltage
• impp::Float64: Maximum power point current
• voc::Float64: Open-circuit voltage
• isc::Float64: Short-circuit current
• pvanumcells::Int: Number of PV cells
• irradiance::Float64: Irradiance (W/m²)
• temperature::Float64: Temperature (°C)
• α_isc::Float64: Short-circuit current temperature coefficient
• β_voc::Float64: Open-circuit voltage temperature coefficient
• control_mode::String: Control mode
• controllable::Bool: Controllability flag
• in_service::Bool: Operating status flag

ExternalGrid <: AbstractComponent

Structure representing an external grid, used for modeling equivalent representations of external power systems.

Fields

• index::Int: Unique identifier for the external grid
• name::String: External grid name
• bus::Int: Connected bus number
• vm_pu::Float64: Voltage magnitude (per unit)
• va_degree::Float64: Voltage angle (degrees)
• in_service::Bool: Operating status flag
• s_sc_max_mva::Float64: Maximum short-circuit capacity (MVA)
• s_sc_min_mva::Float64: Minimum short-circuit capacity (MVA)
• rx_max::Float64: Maximum R/X ratio
• rx_min::Float64: Minimum R/X ratio
• r0x0_max::Float64: Maximum zero-sequence R/X ratio
• x0x_max::Float64: Maximum ratio of zero-sequence to positive-sequence reactance
• controllable::Bool: Controllability flag

Generator <: AbstractComponent

Structure representing a conventional generator unit, including detailed generator parameters and operational characteristics.

Fields

• index::Int: Unique identifier for the generator
• name::String: Generator name
• bus::Int: Connected bus number
• p_mw::Float64: Active power output (MW)
• vm_pu::Float64: Voltage magnitude (per unit)
• sn_mva::Float64: Rated capacity (MVA)
• scaling::Float64: Power scaling factor
• max_p_mw::Float64: Maximum active power limit (MW)
• min_p_mw::Float64: Minimum active power limit (MW)
• max_q_mvar::Float64: Maximum reactive power limit (MVar)
• min_q_mvar::Float64: Minimum reactive power limit (MVar)
• vn_kv::Float64: Rated voltage (kV)
• xdss_pu::Float64: Subtransient direct-axis reactance (per unit)
• rdss_pu::Float64: Subtransient resistance (per unit)
• cos_phi::Float64: Power factor
• controllable::Bool: Controllability flag
• in_service::Bool: Operating status flag
• type::String: Generator type
• generator_type::String: Generator technology type
• fuel_type::String: Fuel type
• startup_time_cold_h::Float64: Cold startup time (hours)
• startup_time_warm_h::Float64: Warm startup time (hours)
• startup_time_hot_h::Float64: Hot startup time (hours)
• min_up_time_h::Float64: Minimum up time (hours)
• min_down_time_h::Float64: Minimum down time (hours)
• ramp_up_rate_mw_per_min::Float64: Ramp-up rate (MW/minute)
• ramp_down_rate_mw_per_min::Float64: Ramp-down rate (MW/minute)
• efficiency_percent::Float64: Efficiency percentage
• heat_rate_mmbtu_per_mwh::Float64: Heat rate (MMBtu/MWh)
• co2_emission_rate_kg_per_mwh::Float64: CO2 emission rate (kg/MWh)

StaticGenerator <: AbstractComponent

Structure representing a static generator, used for modeling simplified generator units.

Fields

• index::Int: Unique identifier for the generator
• name::String: Generator name
• bus::Int: Connected bus number
• p_mw::Float64: Active power output (MW)
• q_mvar::Float64: Reactive power output (MVar)
• scaling::Float64: Power scaling factor
• max_p_mw::Float64: Maximum active power limit (MW)
• min_p_mw::Float64: Minimum active power limit (MW)
• max_q_mvar::Float64: Maximum reactive power limit (MVar)
• min_q_mvar::Float64: Minimum reactive power limit (MVar)
• k::Float64: Coefficient k (typically used for control equations)
• rx::Float64: Resistance to reactance ratio
• in_service::Bool: Operating status flag
• type::String: Generator type (WP-wind power, PV-photovoltaic, CHP-combined heat and power, etc.)
• controllable::Bool: Controllability flag

StaticGeneratorDC <: AbstractComponent

Represents a static generator in a DC power flow model.

Fields

• index::Int: Unique identifier for the generator
• name::String: Name of the generator
• bus::Int: Bus identifier where the generator is connected
• p_mw::Float64: Active power output in MW
• scaling::Float64: Scaling factor for the generator output
• max_p_mw::Float64: Maximum active power output in MW
• min_p_mw::Float64: Minimum active power output in MW
• k::Float64: Participation factor for power balancing
• rx::Float64: R/X ratio of the generator
• in_service::Bool: Operational status (true if in service)
• type::String: Generator type (WP-wind power, PV-photovoltaic, CHP-combined heat and power, etc.)
• controllable::Bool: Whether the generator output can be controlled

StorageAC <: AbstractComponent

Structure representing an AC storage system.

Fields

• index::Int: Unique identifier for the storage system
• name::String: Storage system name
• bus::Int: Connected bus number
• power_capacity_mw::Float64: Power capacity (MW)
• energy_capacity_mwh::Float64: Energy capacity (MWh)
• soc_init::Float64: Initial state of charge
• min_soc::Float64: Minimum state of charge
• max_soc::Float64: Maximum state of charge
• efficiency::Float64: Charging/discharging efficiency
• in_service::Bool: Operating status flag
• type::String: Storage type
• controllable::Bool: Controllability flag

AsymmetricLoad <: AbstractComponent

Structure representing an asymmetric load in power systems.

Fields

• index::Int: Unique identifier for the load
• name::String: Load name
• bus::Int: Bus number where the load is connected
• p_mw::Float64: Active power demand (MW)
• q_mvar::Float64: Reactive power demand (MVAr)
• const_z_percent::Float64: Percentage of constant impedance load model
• const_i_percent::Float64: Percentage of constant current load model
• const_p_percent::Float64: Percentage of constant power load model
• scaling::Float64: Scaling factor for the load
• in_service::Bool: Operating status flag
• type::String: Load connection type (wye, delta, etc.)

Load <: AbstractComponent

Structure representing a symmetric load in power systems.

Fields

• index::Int: Unique identifier for the load
• name::String: Load name
• bus::Int: Bus number where the load is connected
• p_mw::Float64: Active power demand (MW)
• q_mvar::Float64: Reactive power demand (MVAr)
• const_z_percent::Float64: Percentage of constant impedance load model
• const_i_percent::Float64: Percentage of constant current load model
• const_p_percent::Float64: Percentage of constant power load model
• scaling::Float64: Scaling factor for the load
• in_service::Bool: Operating status flag
• type::String: Load connection type (wye, delta, etc.)

LoadDC <: AbstractComponent

Represents a symmetric load model in a DC power flow analysis.

Fields

• index::Int: Unique identifier for the load
• name::String: Name of the load
• bus::Int: Bus identifier where the load is connected
• p_mw::Float64: Active power consumption in MW
• const_z_percent::Float64: Percentage of load with constant impedance characteristic
• const_i_percent::Float64: Percentage of load with constant current characteristic
• const_p_percent::Float64: Percentage of load with constant power characteristic
• scaling::Float64: Scaling factor for the load
• in_service::Bool: Operational status (true if in service)

PVArray <: AbstractComponent

Represents a photovoltaic array in a power system.

Fields

• index::Int: Unique identifier for the PV array
• name::String: Name of the PV array
• bus::Int: Bus identifier where the PV array is connected
• numpanelseries::Int: Number of panels connected in series
• numpanelparallel::Int: Number of panel strings connected in parallel
• vmpp::Float64: Voltage at maximum power point in volts
• impp::Float64: Current at maximum power point in amperes
• voc::Float64: Open circuit voltage in volts
• isc::Float64: Short circuit current in amperes
• pvanumcells::Int: Number of cells in each PV panel
• temperature::Float64: Operating temperature in degrees Celsius
• irradiance::Float64: Solar irradiance in W/m²
• α_isc::Float64: Temperature coefficient of short circuit current in %/°C
• β_voc::Float64: Temperature coefficient of open circuit voltage in %/°C
• in_service::Bool: Operational status (true if in service)

HighVoltageCircuitBreaker <: AbstractComponent

Structure representing high voltage circuit breakers in power systems.

Fields

• index::Int: Unique identifier for the circuit breaker
• name::String: Circuit breaker name
• bus_from::Int: Starting bus number
• bus_to::Int: Ending bus number
• element_type::String: Connected element type (l-line, t-transformer, b-bus)
• element_id::Int: Connected element identifier
• closed::Bool: Circuit breaker status (closed/open)
• type::String: Circuit breaker type (CB-circuit breaker, LS-load switch, DS-disconnector switch)
• z_ohm::Float64: Circuit breaker impedance (Ω)
• in_service::Bool: Operating status flag

Line <: AbstractComponent

Structure representing AC transmission or distribution lines in power systems.

Fields

• index::Int: Unique identifier for the line
• name::String: Line name
• from_bus::Int: Starting bus number
• to_bus::Int: Ending bus number
• length_km::Float64: Line length (km)
• r_ohm_per_km::Float64: Positive sequence resistance per kilometer (Ω/km)
• x_ohm_per_km::Float64: Positive sequence reactance per kilometer (Ω/km)
• c_nf_per_km::Float64: Positive sequence capacitance per kilometer (nF/km)
• r0_ohm_per_km::Float64: Zero sequence resistance per kilometer (Ω/km)
• x0_ohm_per_km::Float64: Zero sequence reactance per kilometer (Ω/km)
• c0_nf_per_km::Float64: Zero sequence capacitance per kilometer (nF/km)
• g_us_per_km::Float64: Conductance per kilometer (μS/km)
• max_i_ka::Float64: Maximum allowable current (kA)
• type::String: Line type (cs-cable, ol-overhead line)
• max_loading_percent::Float64: Maximum loading percentage
• parallel::Int: Number of parallel lines
• df::Float64: Distribution factor
• in_service::Bool: Operating status flag

Reliability Parameters

• mtbf_hours::Float64: Mean time between failures (hours)
• mttr_hours::Float64: Mean time to repair (hours)
• sw_hours::Float64: Switching operation time (hours)
• rp_hours::Float64: Repair preparation time (hours)

LineDC <: AbstractComponent

Represents a DC transmission line in a power system.

Fields

• index::Int: Unique identifier for the line
• name::String: Name of the line
• from_bus::Int: Bus identifier where the line starts
• to_bus::Int: Bus identifier where the line ends
• length_km::Float64: Length of the line in kilometers
• r_ohm_per_km::Float64: Resistance per kilometer in ohms
• x_ohm_per_km::Float64: Reactance per kilometer in ohms
• g_us_per_km::Float64: Conductance per kilometer in microsiemens
• max_i_ka::Float64: Maximum current capacity in kiloamperes
• type::String: Type of the line
• max_loading_percent::Float64: Maximum loading percentage allowed
• parallel::Int: Number of parallel lines
• df::Float64: Derating factor
• in_service::Bool: Operational status (true if in service)
• mtbf_hours::Float64: Mean time between failures in hours
• mttr_hours::Float64: Mean time to repair in hours
• sw_hours::Float64: Switching time in hours
• rp_hours::Float64: Replacement time in hours

Switch <: AbstractComponent

Structure representing switching devices in power systems.

Fields

• index::Int: Unique identifier for the switch
• name::String: Switch name
• bus_from::Int: Starting bus number
• bus_to::Int: Ending bus number
• element_type::String: Connected element type (l-line, t-transformer, b-bus)
• element_id::Int: Connected element identifier
• closed::Bool: Switch status (closed/open)
• type::String: Switch type (CB-circuit breaker, LS-load switch, DS-disconnector switch)
• z_ohm::Float64: Switch impedance (Ω)
• in_service::Bool: Operating status flag

Transformer2W <: AbstractComponent

Represents a two-winding transformer in power systems.

Fields

• index::Int: Unique identifier for the transformer
• name::String: Transformer name
• std_type::String: Standard type
• hv_bus::Int: High voltage bus number
• lv_bus::Int: Low voltage bus number
• sn_mva::Float64: Rated power (MVA)
• vn_hv_kv::Float64: Rated voltage at HV side (kV)
• vn_lv_kv::Float64: Rated voltage at LV side (kV)
• vk_percent::Float64: Short-circuit impedance in percent
• vkr_percent::Float64: Short-circuit resistance in percent
• pfe_kw::Float64: Iron losses (kW)
• i0_percent::Float64: No-load current in percent
• shift_degree::Float64: Phase shift angle in degrees

Tap changer parameters

• tap_side::String: Tap changer side (hv/lv)
• tap_neutral::Int: Neutral tap position
• tap_min::Int: Minimum tap position
• tap_max::Int: Maximum tap position
• tap_step_percent::Float64: Tap step size in percent
• tap_step_degree::Float64: Tap step angle in degrees
• tap_pos::Int: Current tap position
• tap_phase_shifter::Bool: Whether it's a phase shifter

Other parameters

• parallel::Int: Number of parallel transformers
• max_loading_percent::Float64: Maximum loading in percent
• df::Float64: Distribution factor
• in_service::Bool: Operating status flag
• oltc::Bool: Whether it has on-load tap changer
• power_station_unit::Bool: Whether it's a power station transformer

Technical parameters

• vector_group::String: Vector group
• hv_connection::String: HV side connection type (Y/D)
• lv_connection::String: LV side connection type (Y/D)
• thermal_capacity_mw::Float64: Thermal capacity (MW)
• cooling_type::String: Cooling method
• oil_volume_liters::Float64: Oil volume (liters)
• winding_material::String: Winding material

Transformer2Wetap <: AbstractComponent

Represents a two-winding transformer with ETAP parameters.

Fields

• index::Int: Unique identifier for the transformer
• name::String: Transformer name
• std_type::String: Standard type
• hv_bus::Int: High voltage bus number
• lv_bus::Int: Low voltage bus number
• sn_mva::Float64: Rated power (MVA)
• vn_hv_kv::Float64: Rated voltage at HV side (kV)
• vn_lv_kv::Float64: Rated voltage at LV side (kV)
• z_percent::Float64: Impedance in percent
• x_r::Float64: X/R ratio
• z0_percent::Float64: Zero sequence impedance in percent
• x0_r0::Float64: Zero sequence X/R ratio

Tap changer parameters

• tap_neutral::Int: Neutral tap position
• prim_tap::Float64: Primary side tap
• prim_tap_min::Int: Primary side minimum tap position
• prim_tap_max::Int: Primary side maximum tap position
• sec_tap::Float64: Secondary side tap
• sec_tap_min::Int: Secondary side minimum tap position
• sec_tap_max::Int: Secondary side maximum tap position
• vectororwinding::String: Vector or winding type
• phaseshifthl::Float64: Phase shift angle between HV and LV sides
• phaseshiftps: Phase shifter angle

Other parameters

• parallel::Int: Number of parallel transformers
• max_loading_percent::Float64: Maximum loading in percent
• df::Float64: Distribution factor
• in_service::Bool: Operating status flag
• oltc::Bool: Whether it has on-load tap changer
• power_station_unit::Bool: Whether it's a power station transformer
• vector_group::String: Vector group

Transformer3W <: AbstractComponent

Represents a three-winding transformer in power systems.

Fields

• index::Int: Unique identifier for the transformer
• name::String: Transformer name
• std_type::String: Standard type
• hv_bus::Int: High voltage bus number
• mv_bus::Int: Medium voltage bus number
• lv_bus::Int: Low voltage bus number
• sn_hv_mva::Float64: HV side rated power (MVA)
• sn_mv_mva::Float64: MV side rated power (MVA)
• sn_lv_mva::Float64: LV side rated power (MVA)
• vn_hv_kv::Float64: Rated voltage at HV side (kV)
• vn_mv_kv::Float64: Rated voltage at MV side (kV)
• vn_lv_kv::Float64: Rated voltage at LV side (kV)
• vk_hv_percent::Float64: HV side short-circuit impedance in percent
• vk_mv_percent::Float64: MV side short-circuit impedance in percent
• vk_lv_percent::Float64: LV side short-circuit impedance in percent
• vkr_hv_percent::Float64: HV side short-circuit resistance in percent
• vkr_mv_percent::Float64: MV side short-circuit resistance in percent
• vkr_lv_percent::Float64: LV side short-circuit resistance in percent
• pfe_kw::Float64: Iron losses (kW)
• i0_percent::Float64: No-load current in percent
• shift_mv_degree::Float64: MV side phase shift angle in degrees
• shift_lv_degree::Float64: LV side phase shift angle in degrees

Tap changer parameters

• tap_side::String: Tap changer side (hv/mv/lv)
• tap_neutral::Int: Neutral tap position
• tap_min::Int: Minimum tap position
• tap_max::Int: Maximum tap position
• tap_step_percent::Float64: Tap step size in percent
• tap_step_degree::Float64: Tap step angle in degrees
• tap_at_star_point::Bool: Whether tap changer is at star point
• tap_pos::Int: Current tap position

Other parameters

• in_service::Bool: Operating status flag

Technical parameters

• vector_group_hv_mv::String: HV-MV vector group
• vector_group_hv_lv::String: HV-LV vector group
• vector_group_mv_lv::String: MV-LV vector group
• hv_connection::String: HV side connection type (Y/D)
• mv_connection::String: MV side connection type (Y/D)
• lv_connection::String: LV side connection type (Y/D)
• thermal_capacity_mw::Float64: Thermal capacity (MW)
• cooling_type::String: Cooling method
• oil_volume_liters::Float64: Oil volume (liters)
• winding_material::String: Winding material

MobileStorage <: AbstractComponent

Represents a mobile energy storage system that can be relocated within a power network.

Fields

• index::Int: Unique identifier for the mobile storage system
• name::String: Name of the mobile storage system
• type::String: Type of mobile storage (container, trailer, truck, ship)
• capacity_mwh::Float64: Energy storage capacity in MWh
• power_mw::Float64: Maximum power capacity in MW
• soc_percent::Float64: Current state of charge as a percentage (0-100)
• charge_efficiency_percent::Float64: Charging efficiency as a percentage (0-100)
• discharge_efficiency_percent::Float64: Discharging efficiency as a percentage (0-100)
• owner::String: Owner or operator of the mobile storage system
• availability::Float64: Availability factor (0-1)
• current_location::String: Current physical location of the mobile storage
• status::String: Current operational status (available, in_transit, connected, maintenance)

Storage <: AbstractComponent

Represents a stationary energy storage system in a power network.

Fields

• index::Int: Unique identifier for the storage system
• name::String: Name of the storage system
• bus::Int: Bus identifier where the storage system is connected
• power_capacity_mw::Float64: Maximum power capacity in MW
• energy_capacity_mwh::Float64: Energy storage capacity in MWh
• soc_init::Float64: Initial state of charge (0-1)
• min_soc::Float64: Minimum allowed state of charge (0-1)
• max_soc::Float64: Maximum allowed state of charge (0-1)
• efficiency::Float64: Round-trip efficiency of the storage system (0-1)
• in_service::Bool: Operational status (true if in service)
• type::String: Type of storage technology (e.g., "battery", "pumped_hydro")
• controllable::Bool: Whether the storage system can be controlled externally

Storageetap <: AbstractComponent

Represents a detailed electrochemical energy storage model with electrical and thermal parameters.

Fields

• index::Int: Unique identifier for the storage system
• name::String: Name of the storage system
• bus::Int: Bus identifier where the storage system is connected
• ra::Float64: Internal resistance in ohms
• cell::Float64: Number of cells in series per string
• str::Float64: Number of strings in parallel
• package::Float64: Number of packages in parallel
• voc::Float64: Open circuit voltage in volts
• in_service::Bool: Operational status (true if in service)
• type::String: Type of storage technology
• controllable::Bool: Whether the storage system can be controlled externally

Converter Structure

Represents a power converter that connects AC and DC systems, with control capabilities
and operational parameters.

Charger Structure

Represents an individual charging unit within a charging station, with specific power
capabilities and connector types.

ChargingStation Structure

Represents an electric vehicle charging station with multiple chargers and connection
to the power system at a specific bus.

EVAggregator Structure

Represents an entity that aggregates multiple electric vehicles to provide
grid services and manage charging/discharging operations collectively.

V2GService Structure

Represents a vehicle-to-grid service provided by an aggregator, including
service type, time period, capacity, and pricing information.

Microgrid Structure

Represents a microgrid with generation, storage, and load resources that can
operate connected to or isolated from the main grid.

FlexLoad Structure

Represents a flexible load that can adjust its consumption pattern
in response to grid signals or price incentives.

VirtualPowerPlant Structure

Represents a virtual power plant that aggregates distributed energy resources
to provide grid services and operate as a single controllable entity.

CarbonScenario <: AbstractComponent

Represents a carbon emission scenario for power system analysis.

Fields

• index::Int: Unique identifier for the scenario
• name::String: Scenario name
• description::String: Detailed description of the scenario
• year::Int: Target year for the scenario
• grid_carbon_intensity_kgCO2e_per_MWh::Float64: Average grid carbon intensity in kg CO2 equivalent per MWh
• renewable_penetration_percent::Float64: Percentage of renewable energy penetration
• ev_adoption_percent::Float64: Percentage of electric vehicle adoption
• storage_adoption_percent::Float64: Percentage of energy storage adoption

CarbonTimeSeries <: AbstractComponent

Represents a time series of carbon emission data in power systems.

Fields

• index::Int: Unique identifier for the time series record
• timestamp::DateTime: Time point of the carbon emission data
• grid_carbon_intensity_kgCO2e_per_MWh::Float64: Grid carbon intensity in kg CO2 equivalent per MWh
• renewable_generation_carbon_intensity_kgCO2e_per_MWh::Float64: Carbon intensity of renewable generation in kg CO2 equivalent per MWh
• storage_carbon_intensity_kgCO2e_per_MWh::Float64: Carbon intensity of energy storage in kg CO2 equivalent per MWh

EquipmentCarbon <: AbstractComponent

Represents carbon emission data for power system equipment.

Fields

• index::Int: Unique identifier for the equipment carbon record
• element_type::String: Type of equipment (e.g., "transformer", "line", "generator")
• element_id::Int: Identifier of the specific equipment
• carbon_embodied_kgCO2e::Float64: Embodied carbon in the equipment in kg CO2 equivalent
• carbon_operational_kgCO2e_per_year::Float64: Annual operational carbon emissions in kg CO2 equivalent per year
• lifetime_years::Int: Expected lifetime of the equipment in years
• manufacturing_date::Date: Date when the equipment was manufactured
• installation_date::Date: Date when the equipment was installed
• recycling_rate_percent::Float64: Percentage of materials that can be recycled at end of life