pypowsybl.network.Network.get_grounds

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

Get a dataframe of grounds.

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 (Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]) – the data to be selected, as named arguments.

Returns:

the grounds dataframe

Return type:

DataFrame

Notes

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

  • voltage_level_id: at which substation this ground is connected

  • bus_id: bus where this ground is connected

  • bus_breaker_bus_id (optional): bus of the bus-breaker view where this ground is connected

  • node (optional): node where this ground is connected, in node-breaker voltage levels

  • connected: True if the ground is connected to a bus

This dataframe is indexed on the ground ID.