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

Update generators 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:

  • target_p

  • max_p

  • min_p

  • rated_s

  • target_v

  • target_q

  • voltage_regulator_on

  • regulated_element_id: you may define any injection or busbar section as the regulated location.

    Only supported in node breaker voltage levels.

  • p

  • q

  • connected

  • fictitious

See also



Some examples using keyword arguments:

network.update_generators(id='G-1', connected=True, target_p=500)
network.update_generators(id=['G-1', 'G-2'], target_v=[403, 401])