-
Notifications
You must be signed in to change notification settings - Fork 19
Device retrieving related APIs
Format: get_all_buses()
Description: Get all buses in the database.
Args: N/A
Rets:
(1) Tuple of all buses. Empty tuple if no buses in the database.
Example: N/A
Format: get_buses_with_constraints(vbase_min=0.0, vbase_max=10000000.0, v_min=0.0, v_max=10000000.0, area=0, zone=0, owner=0)
Description: Get all buses in the database satisfying all constraints.
Args:
(1) vbase_min: minimum base voltage in kV. Returned buses must have base voltage >= vbase_min.
(2) vbase_max: maximum base voltage in kV. Returned buses must have base voltage <= vbase_max.
(3) v_min: minimum voltage in pu. Returned buses must have pu voltage >= v_min.
(4) v_max: maximum voltage in pu. Returned buses must have pu voltage <= v_max.
(5) area: area number. Returned buses must be in the area. Ignore the area constraint if area=0.
(6) zone: zone number. Returned buses must be in the zone. Ignore the zone constraint if zone=0.
(8) owner: owner number. Returned buses must be of the owner. Ignore the owner constraint if owner=0.
Rets:
(1) Tuple of buses satisfying all constraints. Empty tuple if no buses are satisfying the constants.
Example: N/A
Format: get_all_generators()
Description: Get all generators in the database.
Args: N/A
Rets:
(1) Tuple of all generators. Empty tuple if no generators in the database.
Example: N/A
Format: get_generators_at_bus(bus)
Description: Get all generators in the database.
Args: N/A
Rets:
(1) Tuple of all generators. Empty tuple if no generators in the database.
Example: N/A
Format: get_all_wt_generators()
Description: Get all wind turbine generators in the database.
Args: N/A
Rets:
(1) Tuple of all wind turbine generators. Empty tuple if no wind turbine generators in the database.
Example: N/A
Format: get_wt_generators_at_bus(bus)
Description: Get all wind turbine generators at given bus.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all wind turbine generators at given bus. Empty tuple if no wind turbine generators at given bus.
Example: N/A
Format: get_all_pv_units()
Description: Get all PV units in the database.
Args: N/A
Rets:
(1) Tuple of all PV units. Empty tuple if no PV units in the database.
Example: N/A
Format: get_pv_units_at_bus(bus)
Description: Get all PV units at given bus.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all PV units at given bus. Empty tuple if no PV units at given bus.
Example: N/A
Format: get_all_energy_storages()
Description: Get all energy storages in the database.
Args: N/A
Rets:
(1) Tuple of all energy storages. Empty tuple if no energy storages in the database.
Example: N/A
Format: get_energy_storages_at_bus(bus)
Description: Get all energy storages at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all energy storages at given bus. Empty tuple if no energy storages at given bus.
Example: N/A
Format: get_all_loads()
Description: Get all loads in the database.
Args: N/A
Rets:
(1) Tuple of all loads. Empty tuple if no loads in the database.
Example: N/A
Format: get_loads_at_bus(bus)
Description: Get all loads at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all loads at given bus. Empty tuple if no loads at given bus.
Example: N/A
Format: get_all_fixed_shunts()
Description: Get all fixed shunts in the database.
Args: N/A
Rets:
(1) Tuple of all fixed shunt. Empty tuple if no fixed shunts in the database.
Example: N/A
Format: get_fixed_shunts_at_bus(bus)
Description: Get all fixed shunts at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all fixed shunts at given bus. Empty tuple if no fixed shunts at given bus.
Example: N/A
Format: get_all_equivalent_devices()
Description: Get all equivalent devices in the database.
Args: N/A
Rets:
(1) Tuple of all equivalent devices. Empty tuple if no equivalent devices in the database.
Example: N/A
Format: get_equivalent_devices_at_bus(bus)
Description: Get all equivalent devices at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all equivalent devices at given bus. Empty tuple if no equivalent devices at given bus.
Example: N/A
Format: get_all_lines()
Description: Get all transmission lines in the database.
Args: N/A
Rets:
(1) Tuple of all transmission lines. Empty tuple if no transmission lines in the database.
Example: N/A
Format: get_lines_at_bus(bus)
Description: Get all transmission lines at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all transmission lines at given bus. Empty tuple if no transmission lines at given bus.
Example: N/A
Format: get_lines_between_buses(ibus, jbus)
Description: Get all transmission lines between ibus and jbus.
Args:
(1) ibus: i-side bus number
(2) jbus: j-side bus number
Rets:
(1) Tuple of all transmission lines between given buses. Empty tuple if no transmission lines between given buses.
Example:
get_lines_between_buses(1,2)
Example: N/A Format: get_all_transformers()
Description: Get all transformers in the database.
Args: N/A
Rets:
(1) Tuple of all transformers. Empty tuple if no transformers in the database.
Example: N/A
Format: get_transformers_at_bus(bus)
Description: Get all transformers at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all transformers at given bus. Empty tuple if no transformers at given bus.
Example: N/A
Format: get_transformers_between_buses(ibus, jbus, kbus=0)
Description: Get all transformers between ibus, jbus, and kbus. If kbus=0, two-winding transformers are returned.
Args:
(1) ibus: i-side bus number
(2) jbus: j-side bus number
(3) kbus: k-side bus number, 0 for two-winding transformers
Rets:
(1) Tuple of all transformers between given buses. Empty tuple if no transformers between given buses.
Example:
get_transformers_between_buses(1,2)
get_transformers_between_buses(1,2,0)
get_transformers_between_buses(1,2,3)
Example: N/A Format: get_all_hvdcs()
Description: Get all HVDC links in the database.
Args: N/A
Rets:
(1) Tuple of all HVDC links. Empty tuple if no HVDC links in the database.
Example: N/A
Format: get_hvdcs_at_bus(bus)
Description: Get all HVDC links at bus with input bus number.
Args:
(1) bus: bus number
Rets:
(1) Tuple of all HVDC links at given bus. Empty tuple if no HVDC links at given bus.
Example: N/A
Format: get_hvdcs_between_buses(ibus, jbus)
Description: Get all HVDC links between ibus and jbus.
Args:
(1) ibus: i-side bus number
(2) jbus: j-side bus number
Rets:
(1) Tuple of all HVDC links between given buses. Empty tuple if no HVDC links between given buses.
Example:
get_hvdcs_between_buses(1,2)
Example: N/A Format: get_generators_with_constraints(area=0, zone=0)
Description: Get all generators satisfying area and zone constraints.
Args:
(1) area: Area number. Retured generators must be in the area. Area constraint is ignored if area=0.
(2) zone: Zone number. Retured generators must be in the zone. Zone constraint is ignored if zone=0.
Rets:
(1) Tuple of all generators in given area and zone. Empty tuple if none in given area and zone.
Example: N/A
Format: get_wt_generators_with_constraints(area=0, zone=0)
Description: Get all wind trubine generators satisfying area and zone constraints.
Args:
(1) area: Area number. Retured wind turbine generators must be in the area. Area constraint is ignored if area=0.
(2) zone: Zone number. Retured wind turbine generators must be in the zone. Zone constraint is ignored if zone=0.
Rets:
(1) Tuple of all wind turbine generators in given area and zone. Empty tuple if none in given area and zone.
Example: N/A
Format: get_pv_units_with_constraints(area=0, zone=0)
Description: Get all PV units satisfying area and zone constraints.
Args:
(1) area: Area number. Retured PV units must be in the area. Area constraint is ignored if area=0.
(2) zone: Zone number. Retured PV units must be in the zone. Zone constraint is ignored if zone=0.
Rets:
(1) Tuple of all PV units in given area and zone. Empty tuple if none in given area and zone.
Example: N/A
Format: get_loads_with_constraints(area=0, zone=0)
Description: Get all loads satisfying area and zone constraints.
Args:
(1) area: Area number. Retured loads must be in the area. Area constraint is ignored if area=0.
(2) zone: Zone number. Retured loads must be in the zone. Zone constraint is ignored if zone=0.
Rets:
(1) Tuple of all loads in given area and zone. Empty tuple if none in given area and zone.
Example: N/A
Format: get_all_areas()
Description: Get all areas in the database.
Args: N/A
Rets:
(1) Tuple of all areas number. Empty tuple if no areas in the database.
Example: N/A
Format: get_all_zones()
Description: Get all zones in the database.
Args: N/A
Rets:
(1) Tuple of all zones number. Empty tuple if no zones in the database.
Example: N/A
Format: get_all_owners()
Description: Get all owners in the database.
Args: N/A
Rets:
(1) Tuple of all owners number. Empty tuple if no owners in the database.
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.