pypowsybl.network.create_line_on_line#

create_line_on_line(network, deprecated_bbs_or_bus_id=None, deprecated_new_line_id=None, deprecated_new_line_r=None, deprecated_new_line_x=None, deprecated_new_line_b1=None, deprecated_new_line_b2=None, deprecated_new_line_g1=None, deprecated_new_line_g2=None, deprecated_line_id=None, deprecated_line1_id=None, deprecated_line1_name=None, deprecated_line2_id=None, deprecated_line2_name=None, deprecated_position_percent=None, deprecated_create_fictitious_substation=None, deprecated_fictitious_voltage_level_id=None, deprecated_fictitious_voltage_level_name=None, deprecated_fictitious_substation_id=None, deprecated_fictitious_substation_name=None, df=None, raise_exception=True, reporter=None, report_node=None, **kwargs)[source]#

Connects an existing voltage level to an existing line through a tee point.

Connects an existing voltage level (in practice a voltage level where we have some loads or generations) to an existing line through a tee point. This method cuts an existing line in two, creating a fictitious voltage level between them (on a fictitious substation if asked). Then it links an existing voltage level to this fictitious voltage level by creating a new line described in the provided dataframe.

Parameters:

  • network (Network) – the network

  • df (DataFrame | None) –

    attributes as a dataframe, it should contain:

    • bbs_or_bus_id: the ID of the existing bus or bus bar section of the voltage level voltage_level_id.

    • new_line_id: ID of the new line

    • new_line_r: resistance of the new line, in ohms

    • new_line_x: reactance of the new line, in ohms

    • new_line_b1: shunt susceptance on side 1 of the new line

    • new_line_b2: shunt susceptance on side 2 of the new line

    • new_line_g1: shunt conductance on side 1 of the new line

    • new_line_g2: shunt conductance on side 2 of the new line

    • line_id: the id on of the line on which we want to create a tee point.

    • line1_id: when the initial line is cut, the line segment at side 1 has a given ID (optional).

    • line1_name: when the initial line is cut, the line segment at side 1 has a given name (optional).

    • line2_id: when the initial line is cut, the line segment at side 2 has a given ID (optional).

    • line2_name: when the initial line is cut, the line segment at side 2 has a given name (optional).

    • position_percent: when the existing line is cut in two lines, percent is equal to the ratio between the parameters of the first line and the parameters of the line that is cut multiplied by 100. 100 minus percent is equal to the ratio between the parameters of the second line and the parameters of the line that is cut multiplied by 100.

    • create_fictitious_substation: True to create the fictitious voltage level inside a fictitious substation (false by default).

    • fictitious_voltage_level_id: the ID of the fictitious voltage level (optional) containing the tee point.

    • fictitious_voltage_level_name: the name of the fictitious voltage level (optional) containing the tee point.

    • fictitious_substation_id: the ID of the fictitious substation (optional).

    • fictitious_substation_name: the name of the fictitious substation (optional).

  • 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). bbs_or_bus_id: the ID of the existing bus or bus bar section of the voltage level voltage_level_id.

  • deprecated_bbs_or_bus_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_r (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_x (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_b1 (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_b2 (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_g1 (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_new_line_g2 (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_line_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_line1_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_line1_name (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_line2_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_line2_name (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_position_percent (float | None) – this argument is deprecated, use the dataframe instead

  • deprecated_create_fictitious_substation (bool | None) – this argument is deprecated, use the dataframe instead

  • deprecated_fictitious_voltage_level_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_fictitious_voltage_level_name (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_fictitious_substation_id (str | None) – this argument is deprecated, use the dataframe instead

  • deprecated_fictitious_substation_name (str | None) – this argument is deprecated, use the dataframe instead

  • **kwargs (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) – attributes as keyword arguments

Return type:

None