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

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

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

  • 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 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:



Attributes that can be updated are:

  • section_count

  • p

  • q

  • connected

  • fictitious


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])