Documentation: Relocating algorithmic details from calculations#1316
Conversation
Signed-off-by: Jerry Guo <Jerry.Jinfeng.Guo@alliander.com>
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the user manual by moving detailed algorithmic/mathematical explanations out of docs/user_manual/calculations.md into dedicated pages under docs/algorithms/, and updates the user manual to link to those new detail pages.
Changes:
- Replaced in-page power flow / state estimation / short circuit / tap-changing algorithm details in
calculations.mdwith links to new algorithm detail pages. - Added new detailed algorithm documentation pages for power flow, state estimation, and short circuit calculations.
- Updated various algorithm links in the user manual to point to the new locations.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/user_manual/calculations.md | Removes long algorithm detail sections and replaces them with links to new algorithm pages. |
| docs/algorithms/pf-algorithms.md | New power flow algorithm detail page (including automatic tap changing section). |
| docs/algorithms/se-algorithms.md | New state estimation algorithm detail page (WLS formulation + algorithms). |
| docs/algorithms/sc-algorithms.md | New short circuit algorithm detail page (equations + IEC 60909). |
Comments suppressed due to low confidence (3)
docs/algorithms/sc-algorithms.md:49
- Typo in the standard name: “IEC 609090” should be “IEC 60909”.
In the IEC 609090 standard, there is a difference in `c` (for `U_nom` <= 1kV) for systems with a voltage tolerance of 6%
and 10%.
docs/algorithms/pf-algorithms.md:194
- Typo: “ould be used” is missing the leading “c”.
ould be used.
docs/algorithms/pf-algorithms.md:183
$Y{bus}$doesn’t render as a subscript and is inconsistent with the earlier$Y_{bus}$notation on this page. Use$Y_{bus}$here (and in any other occurrences) to keep the math correct and consistent.
2. Build $Y{bus}$.
Add the admittances of loads/generation to the diagonal elements.
3. Solve linear equation: $YU_N = I_N$ for $U_N$
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
| Outputs for short circuit calculations always give asymmetric output, independent of the fault type present. | ||
| ``` | ||
|
|
||
| ### Power flow algorithms |
There was a problem hiding this comment.
This sub section now feels strange here. The same goes for the subsections bellow of state estimation algorithms and short circuit algorithms.
This are no longer algorithmic detailed sections, but rather overview one with a summary and decision charts. Perhaps these titles should change, or what's more, I'd make them a subsection of the above sections of power flow, state estimation and short circuit ones under calculation types respectively. What do you think?
But they definitely don't belong in this place anymore in my eyes. Perhaps even a separate section (with a name along the lines of calculation selection guide - or something like that) would fit them better, and then just reference to that section from the above for a guide on how to use.
|
|
||
| With power-grid-model it is possible to perform three different types of calculations: | ||
|
|
||
| - [Power flow](#power-flow-algorithms): a "what-if" scenario calculation. |
There was a problem hiding this comment.
For these and the others below, would we want them to send us to the algorithms page instead?
| - Node voltage magnitude and angle | ||
| - Power flow through branches | ||
|
|
||
| See [Power flow algorithms](#power-flow-algorithms) for detailed documentation on the calculation methods. |
There was a problem hiding this comment.
This one (please check the other methods as well), redirects to the old algorithms, do we want to send to the new one instead?
Co-authored-by: Copilot <175728472+Copilot@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>
|
@figueroa1395 Most of your comments are addressed. I will not respond one by one. Please have another look. |
|
I've resolved the comments that you addressed in the commits. The others I'll leave open until there is more input from someone else, as I think they are still valuable and are not addressed. |



Relocated: