pypowsybl.network.Network.get_areas_boundaries#

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

Get a dataframe of areas boundaries.

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 areas boundaries dataframe

Return type:

DataFrame

See also

create_areas_boundaries()

Notes

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

  • id: area identifier

  • boundary_type (optional): either DANGLING_LINE or TERMINAL

  • element: either identifier of the Dangling Line or the equipment terminal

  • side (optional): equipment side

  • ac: True if the boundary is considered as AC and not DC

  • p: Active power at boundary (MW)

  • q: Reactive power at boundary (MW)

This dataframe is indexed on the area ID.

Examples

net = pp.network.create_eurostag_tutorial_example1_with_tie_lines_and_areas()
net.get_areas_boundaries()

will output something like:

element

ac

p

q

id

ControlArea_A

NHV1_XNODE1

True

-301.474347

-116.518644

ControlArea_A

NVH1_XNODE2

True

-301.474347

-116.518644

ControlArea_B

XNODE1_NHV2

True

301.472320

116.434157

ControlArea_B

XNODE2_NHV2

True

301.472320

116.434157