pypowsybl.network.Network.get_branches#

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

Get a dataframe of branches

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 branches.

Return type:

DataFrame

Notes

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

  • type: the type of the branch (line or 2 windings transformer)

  • voltage_level1_id: voltage level where the branch is connected, on side 1

  • bus1_id: bus where this branch is connected, on side 1

  • voltage_level2_id: voltage level where the branch is connected, on side 2

  • bus2_id: bus where this branch is connected, on side 2

This dataframe is indexed on the branche ID.