pypowsybl.network.Network.get_ratio_tap_changer_steps#

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

Get a dataframe of ratio tap changer steps.

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 ratio tap changer steps.

Return type:

DataFrame

Notes

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

  • rho: The voltage ratio in per unit of the rated voltages (in per unit)

  • r: The resistance deviation in percent of nominal value (%)

  • x: The reactance deviation in percent of nominal value (%)

  • g: The conductance deviation in percent of nominal value (%)

  • b: The susceptance deviation in percent of nominal value (%)

This dataframe is index by the id of the transformer and the position of the ratio tap changer step

Examples

net = pp.network.create_eurostag_tutorial_example1_network()
net.get_ratio_tap_changer_steps()

will output something like:

rho

r

x

g

b

id

position

NHV2_NLOAD

0

0.850567

0.0

0.0

0.0

0.0

1

1.000667

0.0

0.0

0.0

0.0

2

1.150767

0.0

0.0

0.0

0.0

net = pp.network.create_eurostag_tutorial_example1_network()
net.get_ratio_tap_changer_steps(all_attributes=True)

will output something like:

rho

r

x

g

b

id

position

NHV2_NLOAD

0

0.850567

0.0

0.0

0.0

0.0

1

1.000667

0.0

0.0

0.0

0.0

2

1.150767

0.0

0.0

0.0

0.0

net = pp.network.create_eurostag_tutorial_example1_network()
net.get_ratio_tap_changer_steps(attributes=['rho','r','x'])

will output something like:

rho

r

x

id

position

NHV2_NLOAD

0

0.850567

0.0

0.0

1

1.000667

0.0

0.0

2

1.150767

0.0

0.0