Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Miscellaneous documentation fixes #893

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] Miscellaneous documentation fixes #893

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d9ae1e
create_lines code sample fix
jeandemanged Nov 14, 2024
6a3d121
create_dangling_lines attributes fix
jeandemanged Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pypowsybl/network/impl/network.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1241,7 +1241,7 @@ def get_dangling_lines(self, all_attributes: bool = False, attributes: List[str]
- **connected**: ``True`` if the dangling line is connected to a bus
- **fictitious** (optional): ``True`` if the dangling line is part of the model and not of the actual network
- **pairing_key**: the pairing key associated to the dangling line, to be used for creating tie lines.
- **ucte-xnode-code**: deprecated for pairing key.
- **ucte_xnode_code**: deprecated for pairing_key.
- **paired**: if the dangling line is paired with a tie line
- **tie_line_id**: the ID of the tie line if the dangling line is paired

Expand Down Expand Up @@ -3970,8 +3970,8 @@ def create_dangling_lines(self, df: DataFrame = None, **kwargs: ArrayLike) -> No
- **x**: the reactance, in Ohms
- **g**: the shunt conductance, in S
- **b**: the shunt susceptance, in S
- **pairing-key**: the optional pairing key associated to the dangling line, to be used for creating tie lines.
- **ucte-x-node-code**: deprecated, use pairing-key instead.
- **pairing_key**: the optional pairing key associated to the dangling line, to be used for creating tie lines.
- **ucte_xnode_code**: deprecated, use pairing_key instead.

Examples:
Using keyword arguments:
Expand Down Expand Up @@ -4161,7 +4161,7 @@ def create_lines(self, df: DataFrame = None, **kwargs: ArrayLike) -> None:

network.create_lines(id='LINE-1', voltage_level1_id='VL1', bus1_id='B1',
voltage_level2_id='VL2', bus2_id='B2',
b1=1e-6, b2=1e-6, g1=0, , g2=0, r=0.5, x=10)
b1=1e-6, b2=1e-6, g1=0, g2=0, r=0.5, x=10)
"""
return self._create_elements(ElementType.LINE, [df], **kwargs)

Expand Down
Loading