Skip to content

Documentation for phase shift transformer (PST) - #1491

Queued
scud-soptim wants to merge 17 commits into
PowerGridModel:mainfrom
scud-soptim:doc/pst-documentation-188
Queued

Documentation for phase shift transformer (PST)#1491
scud-soptim wants to merge 17 commits into
PowerGridModel:mainfrom
scud-soptim:doc/pst-documentation-188

Conversation

@scud-soptim

Copy link
Copy Markdown
Contributor

Fixes #1484

Changes proposed in this PR include

Could you please pay extra attention to the points below when reviewing the PR

For discussion see: #188

@scud-soptim scud-soptim changed the title add documentation for phase shift transformer Documentation for phase shift transformer (PST) Jul 24, 2026

@mgovers mgovers left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @scud-soptim,

Thanks again for the PR. I see, however, that this PR has some duplication with #1485 by another external (first time) contributor.

Both PRs contain useful information. Would it be alright with you to rebase this PR off that PR (or merging it into this one) and combine the two?

In particular, we now have non-pgm-components.md which is intended to contain documentation on any grid components that are not natively supported by PGM (or at least not in name) but can be modeled with PGM components. I think it makes sense to move this documentation there, as per #1485 .

Comment thread docs/user_manual/components.md Outdated
@nitbharambe

Copy link
Copy Markdown
Member

Thanks for sharing this. It's a useful addition for users. And it's good that we can link directly to the ENTSO-E modelling guidelines as a reference.
If you come across similar guidelines for other components, feel free to open an issue for it. This kind of standards-referenced documentation seems like some of the most impactful work we can do for the project.

@scud-soptim

Copy link
Copy Markdown
Contributor Author

Thanks @mgovers and @nitbharambe for the thorough review! I appreciate the feedback. I put together this documentation in response to the request in #1484 and the discussion in #188. However, I don't have the capacity right now to handle rebasing or coordinating with #1485. I'm confident you'll make the best decision about how to integrate the two PRs and which documentation structure serves the project best. Please feel free to make any adjustments you think are appropriate. Thanks for your understanding!

Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/components.md Outdated
Comment thread docs/user_manual/non-pgm-components.md

@Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This PR is good to merge as soon as the way of handling #1485 gets team's accord. See open comment.

@figueroa1395 figueroa1395 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@frie-soptim We are taking over the PR as agreed, but DCO signing is failing because you missed signing commit b81fac3. Can you please amend it?

@nitbharambe nitbharambe added the documentation Improvements or additions to documentation label Aug 11, 2026
frie-soptim and others added 16 commits August 11, 2026 11:07
Signed-off-by: Eduard Fried <eduard.fried@soptim.de>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Jerry Jinfeng Guo <jerry.jinfeng.guo@alliander.com>
Signed-off-by: Jerry Jinfeng Guo <jerry.jinfeng.guo@alliander.com>
Signed-off-by: Jerry Jinfeng Guo <jerry.jinfeng.guo@alliander.com>
@frie-soptim
frie-soptim force-pushed the doc/pst-documentation-188 branch from 05d8cdf to b8f507f Compare August 11, 2026 09:09
@frie-soptim

Copy link
Copy Markdown
Contributor

@frie-soptim We are taking over the PR as agreed, but DCO signing is failing because you missed signing commit b81fac3. Can you please amend it?

@figueroa1395 I have rebased the branch on current main and signed off my commit. Please update your local branch if needed.

Signed-off-by: Jerry Jinfeng Guo <jerry.jinfeng.guo@alliander.com>
@Jerry-Jinfeng-Guo
Jerry-Jinfeng-Guo added this pull request to the merge queue Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IMPROVEMENT] Improve documentation on how to use GenericBranch for Phase Shifting Transformer

7 participants