pypowsybl.network.Network.get_aliases

Network.get_aliases(all_attributes=False, attributes=None, **kwargs)

Get a dataframe of aliases of all network elements.

Args:

Returns:

A dataframe of aliases

Parameters:

• all_attributes (bool) –

• attributes (List[str] | None) –

• kwargs (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) –

Return type:

DataFrame

Notes

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

• type: the type of the network element (network, line, generator, load, …)

• alias: alias value

• alias_type: alias type

This dataframe is indexed on the network element ID.