pypowsybl.network.Network.get_batteries

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

Get a dataframe of batteries.

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:

A dataframe of batteries.

Return type:

DataFrame

Notes

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

  • name: type of load

  • max_p: the maximum active value for the battery (MW)

  • min_p: the minimum active value for the battery (MW)

  • min_q: the maximum reactive value for the battery only if reactive_limits_kind is MIN_MAX (MVar)

  • max_q: the minimum reactive value for the battery only if reactive_limits_kind is MIN_MAX (MVar)

  • max_q_at_target_p (optional): the maximum reactive value for the battery for the target p specified (MVar)

  • min_q_at_target_p (optional): the minimum reactive value for the battery for the target p specified (MVar)

  • max_q_at_p (optional): the maximum reactive value for the battery at current p (MVar)

  • min_q_at_p (optional): the minimum reactive value for the battery at current p (MVar)

  • target_p: The active power setpoint (MW)

  • target_q: The reactive power setpoint (MVAr)

  • p: the result active battery consumption, it is NaN is not loadflow has been computed (MW)

  • q: the result reactive battery consumption, it is NaN is not loadflow has been computed (MVAr)

  • i: the current on the battery, NaN if no loadflow has been computed (in A)

  • voltage_level_id: at which substation this load is connected

  • bus_id: bus where this load is connected

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

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

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

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

This dataframe is indexed on the battery ID.