pypowsybl.network.Network.get_substations#

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

Get substations 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:

A dataframe of substations.

Return type:

DataFrame

Notes

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

  • name: the name of the substations

  • TSO: the TSO which the substation belongs to

  • geo_tags: additional geographical information about the substation

  • country: the country which the substation belongs to

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

This dataframe is indexed on the substation ID.