-
Notifications
You must be signed in to change notification settings - Fork 19
Capacity related APIs
Format: get_allowed_maximum_bus_number()
Description: Get allowed maximum bus number.
Args: N/A
Rets:
(1) Allowed maximum bus number.
Example:
num_max = simulator.get_allowed_maximum_bus_number() Format: set_allowed_maximum_bus_number(max_bus_number)
Description: Set allowed maximum bus number. All buses in the database should be less than the give max bus number.
Args:
(1) max_bus_number: Allowed maximum bus number.
Rets: N/A
Example:
num_max = 10000
simulator.set_allowed_maximum_bus_number(num_max) # 1~10000
num_max = 9000
simulator.set_allowed_maximum_bus_number(num_max) # 1~9000 Format: get_bus_capacity()
Description: Get capacity for storing buses in database.
Args: N/A
Rets:
(1) Maximum number of buses that can be stored in the database.
Example:
nbus_max = simulator.get_bus_capacity() Format: get_generator_capacity()
Description: Get capacity for storing generators in database.
Args: N/A
Rets:
(1) Maximum number of generators that can be stored in the database.
Example:
ngen_max = simulator.get_generator_capacity() Format: get_wt_generator_capacity()
Description: Get capacity for storing wind turbine generators in database.
Args: N/A
Rets:
(1) Maximum number of wind turbine generators that can be stored in the database.
Example:
nwtgen_max = simulator.get_wt_generator_capacity() Format: get_pv_unit_capacity()
Description: Get capacity for storing PV units in database.
Args: N/A
Rets:
(1) Maximum number of PV units that can be stored in the database.
Example:
npv_max = simulator.get_pv_unit_capacity() Format: get_load_capacity()
Description: Get capacity for storing loads in database.
Args: N/A
Rets:
(1) Maximum number of loads that can be stored in the database.
Example:
nload_max = simulator.get_load_capacity() Format: get_fixed_shunt_capacity()
Description: Get capacity for storing fixed shunts in database.
Args: N/A
Rets:
(1) Maximum number of fixed shunts that can be stored in the database.
Example:
nshunt_max = simulator.get_fixed_shunt_capacity() Format: get_line_capacity()
Description: Get capacity for storing transmission lines in database.
Args: N/A
Rets:
(1) Maximum number of transmission lines that can be stored in the database.
Example:
nline_max = simulator.get_line_capacity() Format: get_transformer_capacity()
Description: Get capacity for storing transformers in database.
Args: N/A
Rets:
(1) Maximum number of transformers that can be stored in the database.
Example:
ntrans_max = simulator.get_transformer_capacity() Format: get_hvdc_capacity()
Description: Get capacity for storing HVDC links in database.
Args: N/A
Rets:
(1) Maximum number of HVDC links that can be stored in the database.
Example:
nhvdc_max = simulator.get_hvdc_capacity() Format: get_equivalent_device_capacity()
Description: Get capacity for storing equivalent devices in database.
Args: N/A
Rets:
(1) Maximum number of equivalent devices that can be stored in the database.
Example:
ned_max = simulator.get_equivalent_device_capacity() Format: get_energy_storage_capacity()
Description: Get capacity for storing energy storages in database.
Args: N/A
Rets:
(1) Maximum number of energy storages that can be stored in the database.
Example:
nstorage_max = simulator.get_energy_storage_capacity() Format: get_area_capacity()
Description: Get capacity for storing areas in database.
Args: N/A
Rets:
(1) Maximum number of areas that can be stored in the database.
Example:
narea_max = simulator.get_area_capacity() Format: get_zone_capacity()
Description: Get capacity for storing zones in database.
Args: N/A
Rets:
(1) Maximum number of zones that can be stored in the database.
Example:
nzone_max = simulator.get_zone_capacity() Format: get_owner_capacity()
Description: Get capacity for storing owners in database.
Args: N/A
Rets:
(1) Maximum number of owners that can be stored in the database.
Example:
nowner_max = simulator.get_owner_capacity() Format: set_bus_capacity(capacity)
Description: Set capacity for storing buses in database.
Args:
(1) capacity: Maximum number of buses that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example:
nbus_max = simulator.get_bus_capacity() Format: set_generator_capacity(capacity)
Description: Set capacity for storing generators in database.
Args:
(1) capacity: Maximum number of generators that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_wt_generator_capacity(capacity)
Description: Set capacity for storing wind turbine generators in database.
Args:
(1) capacity: Maximum number of wind turbine generators that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_pv_unit_capacity(capacity)
Description: Set capacity for storing PV units in database.
Args:
(1) capacity: Maximum number of PV units that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_load_capacity(capacity)
Description: Set capacity for storing loads in database.
Args:
(1) capacity: Maximum number of loads that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_fixed_shunt_capacity(capacity)
Description: Set capacity for storing fixed shunts in database.
Args:
(1) capacity: Maximum number of fixed shunts that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_line_capacity(capacity)
Description: Set capacity for storing transmission lines in database.
Args:
(1) capacity: Maximum number of transmission lines that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_transformer_capacity(capacity)
Description: Set capacity for storing transformers in database.
Args:
(1) capacity: Maximum number of transformers that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_hvdc_capacity(capacity)
Description: Set capacity for storing HVDC links in database.
Args:
(1) capacity: Maximum number of HVDC links that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_equivalent_device_capacity(capacity)
Description: Set capacity for storing equivalent devices in database.
Args:
(1) capacity: Maximum number of equivalent devices that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_energy_storage_capacity(capacity)
Description: Set capacity for storing energy storages in database.
Args:
(1) capacity: Maximum number of energy storages that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_area_capacity(capacity)
Description: Set capacity for storing areas in database.
Args:
(1) capacity: Maximum number of areas that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_zone_capacity(capacity)
Description: Set capacity for storing zones in database.
Args:
(1) capacity: Maximum number of zones that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: set_owner_capacity(capacity)
Description: Set capacity for storing owners in database.
Args:
(1) capacity: Maximum number of owners that can be stored in the database.
Rets: N/A
Tips:
This function SHOULD be called before adding devices to the database.
Example: N/A
Format: get_dynamic_model_database_capacity()
Description: Get capacity of dynamic model database.
Args: N/A
Rets:
(1) database capacity in bytes, integer
Example: N/A
Format: set_dynamic_model_database_capacity(cap=10000000)
Description: Set capacity of dynamic model database. If the capacity is not enough, dynamic data cannot be successfully loaded.
Args:
(1) cap: integer, database capacity, in bytes.
Rets:
(1) N/A
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.