pypowsybl.dynamic.ModelMapping.add_base_generator#

ModelMapping.add_base_generator(df=None, **kwargs)[source]#

Add a base generator mapping

Args:

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

Parameters:

df (DataFrame | None) –
kwargs (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) –

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
dynamic_model_id: id of the model mapping the network element (if none the static id will be used)
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_base_generator(static_id='GEN',
                                 parameter_set_id='gen',
                                 dynamic_model_id='DM_GEN',
                                 model_name='GeneratorFictitious')