pypowsybl.network.Network.get_areas_voltage_levels¶
- Network.get_areas_voltage_levels(all_attributes=False, attributes=None, **kwargs)[source]¶
Get a dataframe of areas voltage levels.
- 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 areas voltage levels dataframe
- Return type:
DataFrame
See also
Notes
The resulting dataframe, depending on the parameters, will include the following columns:
id: area identifier
voltage_level_id: voltage level identifier
This dataframe is indexed on the area ID.
Examples
net = pp.network.create_eurostag_tutorial_example1_with_tie_lines_and_areas() net.get_areas_voltage_levels()
will output something like:
voltage_level_id
id
ControlArea_A
VLGEN
ControlArea_A
VLHV1
ControlArea_B
VLHV2
ControlArea_B
VLLOAD
Region_AB
VLGEN
Region_AB
VLHV1
Region_AB
VLHV2
Region_AB
VLLOAD