pypowsybl.network.Network.get_areas#

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

Get a dataframe of areas.

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

Returns:

the areas dataframe

Return type:

DataFrame

See also

get_areas_voltage_levels() to retrieve the voltage levels of the areas
get_areas_boundaries() to retrieve the voltage levels of the areas boundaries
create_areas() to create areas
update_areas() to update areas

Notes

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

area_type: the type of area (e.g. ControlArea, BiddingZone, …)

interchange_target: target active power interchange (MW)

interchange: total (AC + DC) active power interchange, in load sign convention (negative is export, positive is import) (MW)

ac_interchange: AC active power interchange, in load sign convention (negative is export, positive is import) (MW)

dc_interchange: DC active power interchange, in load sign convention (negative is export, positive is import) (MW)

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

This dataframe is indexed on the area ID.

Examples

net = pp.network.create_eurostag_tutorial_example1_with_tie_lines_and_areas()
net.get_areas()

will output something like:

	name	area_type	interchange_target	interchange	ac_interchange	dc_interchange
id
ControlArea_A	Control Area A	ControlArea	-602.6	-602.948693	-602.948693	0.0
ControlArea_B	Control Area B	ControlArea	602.6	602.944639	602.944639	0.0
Region_AB	Region AB	Region	NaN	0.000000	0.000000	0.0