-
Notifications
You must be signed in to change notification settings - Fork 19
Device existance related APIs
Format: is_bus_exist(bus)
Description: Check if given bus exists or not.
Args:
(1) bus: bus number.
Rets:
(1) True if the bus exists, False otherwise.
Example: N/A
Format: is_generator_exist(generator)
Description: Check if given generator exists or not.
Args:
(1) generator: tuple of generator device id in format of (bus, ickt).
Rets:
(1) True if the generator exists, False otherwise.
Example: N/A
Format: is_wt_generator_exist(generator)
Description: Check if given wind turbine generator exists or not.
Args:
(1) generator: tuple of wind turbine generator device id in format of (bus, ickt).
Rets:
(1) True if the wind turbine generator exists, False otherwise.
Example: N/A
Format: is_pv_unit_exist(pv_unit)
Description: Check if given PV unit exists or not.
Args:
(1) pv_unit: tuple of PV unit device id in format of (bus, ickt).
Rets:
(1) True if the PV unit exists, False otherwise.
Example: N/A
Format: is_load_exist(load)
Description: Check if given load exists or not.
Args:
(1) load: tuple of load device id in format of (bus, ickt).
Rets:
(1) True if the load exists, False otherwise.
Example: N/A
Format: is_fixed_shunt_exist(shunt)
Description: Check if given fixed shunt exists or not.
Args:
(1) shunt: tuple of fixed shunt device id in format of (bus, ickt).
Rets:
(1) True if the fixed shunt exists, False otherwise.
Example: N/A
Format: is_line_exist(line)
Description: Check if given transmission line exists or not.
Args:
(1) line: tuple of transmission line device id in format of (ibus, jbus, ickt).
Rets:
(1) True if the transmission line exists, False otherwise.
Example: N/A
Format: is_transformer_exist(transformer)
Description: Check if given transformer exists or not.
Args:
(1) transformer: tuple of transformer device id in format of (ibus, jbus, ickt) or (ibus, jbus, kbus, ickt).
Rets:
(1) True if the transformer exists, False otherwise.
Tips:
kbus can be omitted if kbus=0, a.k.a., (ibus, jbus, 0, ickt) can be simplified as (ibus, jbus, ickt).
Example: N/A
Format: is_hvdc_exist(hvdc)
Description: Check if given HVDC link exists or not.
Args:
(1) hvdc: tuple of HVDC link device id in format of (ibus, jbus, ickt).
Rets:
(1) True if the HVDC link exists, False otherwise.
Example: N/A
Format: is_equivalent_device_exist(equivalent_device)
Description: Check if given equivalent device exists or not.
Args:
(1) equivalent_device: tuple of equivalent device device id in format of (bus, ickt).
Rets:
(1) True if the equivalent device exists, False otherwise.
Example: N/A
Format: is_energy_storage_exist(energy_storage)
Description: Check if given energy storage device exists or not.
Args:
(1) energy_storage: tuple of energy storage device id in format of (bus, ickt).
Rets:
(1) True if the energy storage device exists, False otherwise.
Example: N/A
Cite STEPS via: Changgang Li, Yue Wu, Hengxu Zhang, Hua Ye, Yutian Liu and Yilu Liu, "STEPS: A Portable Numerical Simulation Toolkit for Electrical Power System Dynamic Studies," in IEEE Transactions on Power Systems, doi: 10.1109/TPWRS.2020.3045102.