pypowsybl.network.create_shunt_compensator_bay#

create_shunt_compensator_bay(network, shunt_df, linear_model_df=None, non_linear_model_df=None, raise_exception=True, reporter=None, report_node=None)[source]#

Creates a shunt compensator, connects it to the network on a given bus or busbar section and creates the associated topology.

Parameters:

  • network (Network) – the network to which we want to add the shunt compensator

  • shunt_df (DataFrame) – dataframe for shunt compensators data

  • linear_model_df (DataFrame | None) – dataframe for linear model sections data

  • non_linear_model_df (DataFrame | None) – dataframe for sections data

  • raise_exception (bool) – optionally, whether the calculation should throw exceptions. In any case, errors will be logged. Default is True.

  • reporter (ReportNode | None) – deprecated, use report_node instead

  • report_node (ReportNode | None) – optionally, the reporter to be used to create an execution report, default is None (no report).

Return type:

None

Notes

The voltage level containing the busbar section can be described in node/breaker or bus/breaker topology. If the voltage level is node/breaker, the shunt compensator is connected to the busbar with a breaker and a closed disconnector. If the network has position extensions, the shunt compensator will also be connected to every parallel busbar section with an open disconnector. If the voltage level is bus/breaker, the shunt compensator is just connected to the bus.

Valid attributes for the shunt compensators dataframe are:

  • id: the identifier of the new shunt

  • name: an optional human-readable name

  • model_type: either LINEAR or NON_LINEAR

  • section_count: the current count of connected sections

  • target_v: an optional target voltage in kV

  • target_v: an optional deadband for the target voltage, in kV

  • bus_or_busbar_section_id: id of the bus or of the busbar section to which the injection will be connected with a closed disconnector.

  • position_order: in node/breaker, the order of the shunt compensator, will fill the ConnectablePosition extension

  • direction: optionally, in node/breaker, the direction of the shunt compensator, will fill the ConnectablePosition extension, default is BOTTOM.

Valid attributes for the linear sections models are:

  • id: the identifier of the new shunt

  • g_per_section: the conductance, in Ohm, for each section

  • b_per_section: the susceptance, in Ohm, for each section

  • max_section_count: the maximum number of connectable sections

This dataframe must have only one row for each shunt compensator.

Valid attributes for the non-linear sections models are:

  • id: the identifier of the new shunt

  • g: the conductance, in Ohm, for this section

  • b: the susceptance, in Ohm, for this section