pypowsybl.dynamic.ModelMapping.add_shunt¶

ModelMapping.add_shunt(df=None, **kwargs)[source]¶

Add a shunt compensator mapping

Args:

df: Attributes as a dataframe. kwargs: Attributes as keyword arguments.

Parameters:

df (DataFrame | None)
kwargs (Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str])

Return type:

None

Notes

Data may be provided as a dataframe or as keyword arguments. In the latter case, all arguments must have the same length.

Valid attributes are:

static_id: id of the network element to map
parameter_set_id: id of the parameter for this model given in the dynawo configuration
model_name: name of the model used for the mapping (if none the default model will be used)

Examples

Using keyword arguments:

model_mapping.add_shunt(static_id='SHUNT',
                               parameter_set_id='sh',
                               model_name='ShuntB')