pypowsybl.network.Network.create_areas_boundaries

Network.create_areas_boundaries(df=None, **kwargs)[source]

Define boundaries of (existing) areas.

Parameters:

  • df (DataFrame | None) – Attributes 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

Data may be provided as a dataframe or as keyword arguments. In the latter case, all arguments must have the same length.

Important: The provided boundaries for an area replace all existing boundaries of that area, i.e. the entire list of boundaries must be provided for the areas being edited.

Valid attributes are:

  • id: the identifier of the area

  • boundary_type: either BOUNDARY_LINE or TERMINAL, defaults to BOUNDARY_LINE.

  • element: boundary line identifier, or any connectable

  • side: if element is not a boundary line (e.g. a branch or transformer), the terminal side

  • ac: True is boundary is to be considered as AC

See also

get_areas_boundaries()

Examples

# define boundary lines NHV1_XNODE1 and NVH1_XNODE2 as boundaries of AreaA, and
# define boundary lines XNODE1_NHV2 and XNODE2_NHV2 as boundaries of AreaB
network.create_areas_boundaries(id=['AreaA', 'AreaA', 'AreaB', 'AreaB'],
                                boundary_type=['BOUNDARY_LINE', 'BOUNDARY_LINE', 'BOUNDARY_LINE', 'BOUNDARY_LINE'],
                                element=['NHV1_XNODE1', 'NVH1_XNODE2', 'XNODE1_NHV2', 'XNODE2_NHV2'],
                                ac=[True, True, True, True])

To dissociate all Boundaries of a given area, provide an empty string in element.

network.create_areas_boundaries(id=['Area1'], element=[''])