pypowsybl.network.Network.get_terminals

Network.get_terminals(all_attributes=False, attributes=None)[source]

Get a dataframe of terminal

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.

Returns:

A dataframe of terminals.

Return type:

DataFrame

Notes

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

  • voltage_level_id: voltage level where the terminal is connected

  • bus_id: bus where this terminal is

  • element_side: if it is a terminal of a branch it will indicate his side else it is “”

This dataframe is indexed on the element ID of the terminal.