pypowsybl.network.Network.update_shunt_compensators

Network.update_shunt_compensators(df=None, **kwargs)[source]

Update shunt compensators with data provided as a DataFrame or as named arguments.

Parameters:

  • df (DataFrame | None) – the data to be updated, as a dataframe.

  • kwargs (Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str]) – the data to be updated, as named arguments. Arguments can be single values or any type of sequence. In the case of sequences, all arguments must have the same length.

Return type:

None

Notes

Attributes that can be updated are:

  • section_count

  • p

  • q

  • connected

  • fictitious

See also

get_shunt_compensators()

Examples

Some examples using keyword arguments:

network.update_shunt_compensators(id='IND-1', section_count=1, connected=True)
network.update_shunt_compensators(id=['IND-1', 'CAP-1'], section_count=[1, 0])