pypowsybl.network.Network.get_vsc_converter_stations#

Network.get_vsc_converter_stations(all_attributes=False, attributes=None, **kwargs)[source]#

Get a dataframe of VSC converter stations.

Parameters:
  • all_attributes (bool) – flag for including all attributes in the dataframe, default is false

  • attributes (List[str] | None) – attributes to include in the dataframe. The 2 parameters are mutually exclusive. If no parameter is specified, the dataframe will include the default attributes.

  • kwargs (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) – the data to be selected, as named arguments.

Returns:

A dataframe of VCS converter stations.

Return type:

DataFrame

Notes

The resulting dataframe, depending on the parameters, will include the following columns:

  • loss_factor: correspond to the loss of power due to ac dc conversion

  • target_v: The voltage setpoint

  • target_q: The reactive power setpoint

  • max_q: the maximum reactive value for the generator only if reactive_limits_kind is MIN_MAX (MVar)

  • min_q: the minimum reactive value for the generator only if reactive_limits_kind is MIN_MAX (MVar)

  • max_q_at_p (optional): the maximum reactive value for the generator at current p (MVar)

  • min_q_at_p (optional): the minimum reactive value for the generator at current p (MVar)

  • reactive_limits_kind: type of the reactive limit of the vsc converter station (can be MIN_MAX, CURVE or NONE)

  • voltage_regulator_on: The voltage regulator status

  • regulated_element_id: The ID of the network element where voltage is regulated

  • p: active flow on the VSC converter station, NaN if no loadflow has been computed (in MW)

  • q: the reactive flow on the VSC converter station, NaN if no loadflow has been computed (in MVAr)

  • i: The current on the VSC converter station, NaN if no loadflow has been computed (in A)

  • voltage_level_id: at which substation the VSC converter station is connected

  • bus_id: bus where this station is connected

  • bus_breaker_bus_id (optional): bus of the bus-breaker view where this station is connected

  • node (optional): node where this station is connected, in node-breaker voltage levels

  • connected: True if the VSC converter station is connected to a bus

  • fictitious (optional): True if the VSC converter is part of the model and not of the actual network

This dataframe is indexed by the id of the VSC converter

Examples

net = pp.network.create_four_substations_node_breaker_network()
net.get_vsc_converter_stations()

will output something like:

loss_factor

voltage_setpoint

reactive_power_setpoint

voltage_regulator_on

regulated_element_id

p

q

i

voltage_level_id

bus_id

connected

id

VSC1

1.1

400.0

500.0

True

VSC1

10.11

-512.0814

739.269871

S1VL2

S1VL2_0

True

VSC2

1.1

0.0

120.0

False

VSC2

-9.89

-120.0000

170.031658

S2VL1

S2VL1_0

True

net = pp.network.create_four_substations_node_breaker_network()
net.get_vsc_converter_stations(all_attributes=True)

will output something like:

loss_factor

target_v

target_q

voltage_regulator_on

regulated_element_id

p

q

i

voltage_level_id

bus_id

connected

id

VSC1

1.1

400.0

500.0

True

VSC1

10.11

-512.0814

739.269871

S1VL2

S1VL2_0

True

VSC2

1.1

0.0

120.0

False

VSC2

-9.89

-120.0000

170.031658

S2VL1

S2VL1_0

True

net = pp.network.create_four_substations_node_breaker_network()
net.get_vsc_converter_stations(attributes=['p','q','i','voltage_level_id','bus_id','connected'])

will output something like:

p

q

i

voltage_level_id

bus_id

connected

id

VSC1

10.11

-512.0814

739.269871

S1VL2

S1VL2_0

True

VSC2

-9.89

-120.0000

170.031658

S2VL1

S2VL1_0

True