pypowsybl.network.Network.create_boundary_lines

Network.create_boundary_lines(df=None, generation_df=Empty DataFrame Columns: [] Index: [], **kwargs)[source]

Creates boundary lines.

Parameters:

  • df (DataFrame | None) – Attributes as a dataframe.

  • generation_df (DataFrame) – Attributes of the boundary lines optional generation part, only as a dataframe

  • kwargs (Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]) – Attributes as keyword arguments.

Return type:

None

Notes

General boundary line 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 line

  • voltage_level_id: the voltage level where the new line will be created. The voltage level must already exist.

  • bus_id: the bus where the new line will be connected, if the voltage level has a bus-breaker topology kind.

  • connectable_bus_id: the bus where the new line will be connectable, if the voltage level has a bus-breaker topology kind.

  • node: the node where the new line will be connected, if the voltage level has a node-breaker topology kind.

  • name: an optional human-readable name

  • p0: the active power consumption, in MW

  • q0: the reactive power consumption, in MVar

  • r: the resistance, in Ohms

  • x: the reactance, in Ohms

  • g: the shunt conductance, in S

  • b: the shunt susceptance, in S

  • pairing_key: the optional pairing key associated to the boundary line, to be used for creating tie lines.

  • ucte_xnode_code: deprecated, use pairing_key instead.

Boundary line generation information must be provided as a dataframe. Valid attributes are:

  • id: Identifier of the boundary line that contains this generation part

  • min_p: Minimum active power output of the boundary line’s generation part

  • max_p: Maximum active power output of the boundary line’s generation part

  • target_p: Active power target of the generation part

  • target_q: Reactive power target of the generation part

  • target_v: Voltage target of the generation part

  • voltage_regulator_on: True if the generation part regulates voltage

Examples

Using keyword arguments:

network.create_boundary_lines(id='BAT-1', voltage_level_id='VL1', bus_id='B1',
                              p0=10, q0=3, r=0, x=5, g=0, b=1e-6)