pypowsybl.network.Network.create_generators#

Network.create_generators(df=None, **kwargs)[source]#

Creates generators.

Parameters:

df (DataFrame | None) – Attributes as dataframe.
kwargs (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) – Attributes as keyword arguments.

Return type:

None

Notes

Data may be provided as a dataframe or as keyword arguments. In the latter case, all arguments must have the same length.

Valid attributes are:

id: the identifier of the new generator
voltage_level_id: the voltage level where the new generator will be created. The voltage level must already exist.
bus_id: the bus where the new generator will be connected, if the voltage level has a bus-breaker topology kind.
connectable_bus_id: the bus where the new generator will be connectable, if the voltage level has a bus-breaker topology kind.
node: the node where the new generator will be connected, if the voltage level has a node-breaker topology kind.
energy_source: the type of energy source (HYDRO, NUCLEAR, …)
condenser: define if the generator is a condenser (boolean)
max_p: maximum active power in MW
min_p: minimum active power in MW
target_p: target active power in MW
target_q: target reactive power in MVar, when the generator does not regulate voltage
rated_s: nominal power in MVA
target_v: target voltage in kV, when the generator regulates voltage
voltage_regulator_on: true if the generator regulates voltage

Examples

Using keyword arguments:

network.create_generators(id='GEN',
                          voltage_level_id='VL1',
                          bus_id='B1',
                          target_p=100,
                          min_p=0,
                          max_p=200,
                          target_v=400,
                          voltage_regulator_on=True)