add_bus

Format: add_bus(busnumber, busname, basevoltage)
Description: Add new bus with bus number, bus name, and base voltage.
Args:

(1) busnumber: Bus number.
(2) busname: String of bus name.
(3) basevoltage: Base voltage in kV.

Rets: N/A

Example: N/A

add_generator

Format: add_generator(generator)
Description: Add new generator with device id.
Args:

(1) generator: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_wt_generator

Format: add_wt_generator(generator)
Description: Add new wind turbine generator with device id.
Args:

(1) generator: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_pv_unit

Format: add_pv_unit(unit)
Description: Add new PV unit with device id.
Args:

(1) unit: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_load

Format: add_load(load)
Description: Add new load with device id.
Args:

(1) load: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_fixed_shunt

Format: add_fixed_shunt(shunt)
Description: Add new fixed shunt with device id.
Args:

(1) shunt: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_line

Format: add_line(line)
Description: Add new transmission line with device id.
Args:

(1) line: Tuple device id in format of (ibus, jbus, ickt).

Rets: N/A

Example: N/A

add_hvdc

Format: add_hvdc(hvdc)
Description: Add new HVDC link with device id.
Args:

(1) hvdc: Tuple device id in format of (ibus, jbus, ickt).

Rets: N/A

Example: N/A

add_transformer

Format: add_transformer(transformer)
Description: Add new transformer with device id.
Args:

(1) transformer: Tuple device id in format of (ibus, jbus, ickt) or (ibus, jbus, kbus, ickt).

Rets: N/A

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

add_equivalent_device

Format: add_equivalent_device(device)
Description: Add new equivalent device with device id.
Args:

(1) device: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_energy_storage

Format: add_energy_storage(storage)
Description: Add new energy storage with device id.
Args:

(1) storage: Tuple device id in format of (bus, ickt).

Rets: N/A

Example: N/A

add_area

Format: add_area(areanumber, areaname)
Description: Add new area with area number and area name.
Args:

(1) areanumber: Area number.
(2) areaname: String of area name.

Rets: N/A

Example: N/A

add_zone

Format: add_zone(zonenumber, zonename)
Description: Add new zone with zone number and zone name.
Args:

(1) zonenumber: Zone number.
(2) zonename: String of zone name.

Rets: N/A

Example: N/A

add_owner

Format: add_owner(ownernumber, ownername)
Description: Add new owner with owner number and owner name.
Args:

(1) ownernumber: Owner number.
(2) ownername: String of owner name.

Rets: N/A

Example: N/A

remove_bus

Format: remove_bus(busnumber)
Description: Remove bus of bus number.
Args:

(1) busnumber: Bus number.

Rets: N/A

Example: N/A

remove_generator

Format: remove_generator(generator)
Description: Remove generator with device id.
Args:

(1) generator: Tuple generator device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_wt_generator

Format: remove_wt_generator(generator)
Description: Remove wind turbine generator with device id.
Args:

(1) generator: Tuple wind turbine generator device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_pv_unit

Format: remove_pv_unit(unit)
Description: Remove PV unit with device id.
Args:

(1) unit: Tuple PV unit device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_load

Format: remove_load(load)
Description: Remove load with device id.
Args:

(1) load: Tuple load device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_fixed_shunt

Format: remove_fixed_shunt(shunt)
Description: Remove fixed shunt with device id.
Args:

(1) shunt: Tuple fixed shunt device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_line

Format: remove_line(line)
Description: Remove transmission line with device id.
Args:

(1) line: Tuple transmission line device id in format of (ibus, jbus, ickt).

Rets: N/A

Example: N/A

remove_hvdc

Format: remove_hvdc(hvdc)
Description: Remove HVDC link with device id.
Args:

(1) hvdc: Tuple HVDC link device id in format of (ibus, jbus, ickt).

Rets: N/A

Example: N/A

remove_transformer

Format: remove_transformer(transformer)
Description: Remove transformer with device id.
Args:

(1) transformer: Tuple transformer device id in format of (ibus, jbus, ickt) or (ibus, jbus, kbus, ickt).

Rets: N/A

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

remove_equivalent_device

Format: remove_equivalent_device(device)
Description: Remove equivalent device with device id.
Args:

(1) device: Tuple equivalent device device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_energy_storage

Format: remove_energy_storage(storage)
Description: Remove energy storage with device id.
Args:

(1) storage: Tuple energy storage device id in format of (bus, ickt).

Rets: N/A

Example: N/A

remove_area

Format: remove_area(areanumber)
Description: Remove area with area number.
Args:

(1) arenumber: area number to remove.

Rets: N/A

Example: N/A

remove_zone

Format: remove_zone(zonenumber)
Description: Remove zone with zone number.
Args:

(1) zonenumber: zone number to remove.

Rets: N/A

Example: N/A

remove_owner

Format: remove_owner(ownernumber)
Description: Remove owner with owner number.
Args:

(1) ownernumber: owner number to remove.

Rets: N/A

Example: N/A

change_bus_number

Format: change_bus_number(old_number, new_number)
Description: Change bus number in the database..
Args:

(1) old_number: Old bus number.
(2) new_number: New bus number.

Rets: N/A

Tips:

The new_number should be valid, a.k.a, should be positive and < system allowed maximum bus number.

Example: N/A

change_bus_number_with_file

Format: change_bus_number_with_file(file)
Description: Change bus number in the database with csv file.
Args:

(1) file: Bus pair csv file.

Rets: N/A

Tips:

The bus pair csv should have no header lines. Each line is a record, and each record should have the following format: "original_number, new_number".
It is recommended that there should be no intersection between the sets of new bus numbers and old bus numbers.

Example: N/A