pypowsybl.network.Network.get_linear_shunt_compensator_sections¶

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

Get a dataframe of shunt compensators sections for linear model.

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.

Return type:

DataFrame

Notes

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

g_per_section: the conductance per section in S

b_per_section: the susceptance per section in S

max_section_count: the maximum number of sections

This dataframe is indexed by the shunt compensator ID.

Returns:

A dataframe of linear models of shunt compensators.

Parameters:

all_attributes (bool)
attributes (List[str] | None)
kwargs (Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str])

Return type:

DataFrame