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.

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

Improve CGMES documentation regarding transformers and boundaries #290

Merged
merged 18 commits into from
Jun 4, 2024

Conversation

miovd
Copy link
Contributor

@miovd miovd commented May 5, 2023

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce?
Doc update: complete documentation regarding CGMES import of transformers and equipment at boundary

Signed-off-by: VEDELAGO MIORA <miora.ralambotiana@rte-france.com>
Copy link
Collaborator

@So-Fras So-Fras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you again for the documentation work. Most of my remarks are about typos.

pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
- If there is exactly one other `ACLineSegment` linked to this `TopologicalNode` in another `SubGeographicalRegion`, they are both mapped to PowSybl [`HalfLines`](../model/index.md#half-line), part of the same PowSyBl [`TieLine`](../model/index.md#tie-line).
- If there are two or more other `ACLineSegment` linked to this `TopologicalNode` in different `SubGeographicalRegions`:
- If there are only two `ACLineSegments` with their boundary terminal connected **and** in different `SubGeographicalRegion`, they are both mapped to PowSybl [`HalfLines`](../model/index.md#half-line), part of the same PowSyBl [`TieLine`](../model/index.md#tie-line) and all other `ACLineSegments` are mapped to PowSyBl [`DanglingLines`](../model/index.md#dangling-line).
If the `ACLineSegment` has one side inside the boundary area and one side outside the boundary area, the importer checks if another linking equipment is linked to the same CGMES [`TopologicalNode`](#TopologicalNode) in the boundary area.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that there is a link to a page or a paragraph for TopologicalNode :
[TopologicalNode](#TopologicalNode)

Where is it supposed to link to ?

This link is present at the beginning of each paragraph (AC Line, line, 2WT, switch).

pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
pages/documentation/grid/formats/cim-cgmes.md Outdated Show resolved Hide resolved
miovd and others added 13 commits June 1, 2023 09:43
Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Co-authored-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>
Signed-off-by: miovd <miora.ralambotiana@rte-france.com>
Signed-off-by: VEDELAGO MIORA <miora.ralambotiana@rte-france.com>
@So-Fras
Copy link
Collaborator

So-Fras commented May 24, 2024

@colinepiloquet I know you have transfered most of the cim-cgmes documentation in readthedocs. What about this PR? Could you check if there is something to get from it and then close it?
Thanks a lot!

@annetill
Copy link
Member

@colinepiloquet I know you have transfered most of the cim-cgmes documentation in readthedocs. What about this PR? Could you check if there is something to get from it and then close it? Thanks a lot!

Indeed I don't like "linking device".

@colinepiloquet
Copy link
Contributor

@colinepiloquet I know you have transfered most of the cim-cgmes documentation in readthedocs. What about this PR? Could you check if there is something to get from it and then close it? Thanks a lot!

Indeed I don't like "linking device".

Me neither. We do need to integrate this PR in the documentation though. I have trouble finding another word for linking device.

Signed-off-by: Coline PILOQUET <coline.piloquet@rte-france.com>
@colinepiloquet
Copy link
Contributor

I have done some corrections, according to your feedback @So-Fras and @annetill. Once merged, I will transfer it to the documentation on readthedocs.

Signed-off-by: Coline PILOQUET <coline.piloquet@rte-france.com>
@So-Fras So-Fras merged commit 373f44a into main Jun 4, 2024
2 checks passed
@So-Fras So-Fras deleted the cgmes_doc_transfo_boundaries branch June 4, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants