pypowsybl.network.Network.get_phase_tap_changers#

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

Create a phase tap changers:class:~pandas.DataFrame.

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:

the phase tap changers dataframe

Return type:

DataFrame

Notes

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

  • tap: the current tap position

  • low_tap: the low tap position (usually 0, but could be different depending on the data origin)

  • high_tap: the high tap position

  • step_count: the count of taps, should be equal to (high_tap - low_tap)

  • regulating: true if the phase shifter is in regulation

  • regulation_mode: regulation mode, among CURRENT_LIMITER, ACTIVE_POWER_CONTROL, and FIXED_TAP

  • regulation_value: the target value, in A or MW, depending on regulation_mode

  • target_deadband: the regulation deadband around the target value

  • regulationg_bus_id: the bus where the phase shifter regulates

  • regulated_side (optional): the side bus where the phase shifter regulates current or active power

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

This dataframe is indexed by the id of the transformer

Examples

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

will output something like:

tap

low_tap

high_tap

step_count

regulating

regulation_mode

regulation_value

target_deadband

regulating_bus_id

id

TWT

15

0

32

33

False

FIXED_TAP

NaN

NaN

S1VL1_0

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

will output something like:

tap

low_tap

high_tap

step_count

regulating

regulation_mode

regulation_value

target_deadband

regulating_bus_id

id

TWT

15

0

32

33

False

FIXED_TAP

NaN

NaN

S1VL1_0

 
net = pp.network.create_four_substations_node_breaker_network()
net.get_phase_tap_changers(attributes=['tap','low_tap','high_tap','step_count','regulating_bus_id'])

will output something like:

tap

low_tap

high_tap

step_count

regulating_bus_id

id

TWT

15

0

32

33

S1VL1_0