create_load_bay(network, df=None, raise_exception=False, reporter=None, **kwargs)[source]#

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

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

  • df (Optional[DataFrame]) – Attributes as a dataframe.

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

  • reporter (Optional[Reporter]) – optionally, the reporter to be used to create an execution report, default is None (no report).

  • kwargs (Union[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]]]) –

Return type:



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 load is connected to the busbar with a breaker and a closed disconnector. If the network has position extensions, the load will also be connected to every parallel busbar section with an open disconnector. If the voltage level is bus/breaker, the load is just connected to the bus.

Valid attributes are:

  • id: the identifier of the new load

  • name: an optional human-readable name

  • type: optionally, the type of load (UNDEFINED, AUXILIARY, FICTITIOUS)

  • p0: active power load, in MW

  • q0: reactive power load, in MVar

  • 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 load, will fill the ConnectablePosition extension

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