Skip to content

Commit fb129b8

Browse files
committed
make algorithms its own docs section
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
1 parent cf6aebc commit fb129b8

File tree

3 files changed

+9
-16
lines changed

3 files changed

+9
-16
lines changed

docs/advanced_documentation/algorithms/index.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/advanced_documentation/algorithms/lu-solver.md renamed to docs/algorithms/lu-solver.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ discussed in the [section on pivot perturbation](#pivot-perturbation).
8484
#### Matrix properties of power system equations
8585

8686
The matrices involved in
87-
[power flow equations](../../user_manual/calculations.md#power-flow-algorithms) are not Hermitian,
87+
[power flow equations](../user_manual/calculations.md#power-flow-algorithms) are not Hermitian,
8888
nor positive (semi-)definite. As a result, methods that depend on that property cannot be used.
8989

9090
The matrices involved in
91-
[state estimation equations](../../user_manual/calculations.md#state-estimation-algorithms),
91+
[state estimation equations](../user_manual/calculations.md#state-estimation-algorithms),
9292
instead, are, in fact, intrinsically both positive definite and Hermitian. However, for
9393
[performance reasons](#performance-considerations), the matrix equation is augmented to achieve
9494
a consistent structure across the entire topology using Lagrange multipliers. This augmented
@@ -952,7 +952,7 @@ tolerance.
952952
In power system equations, the matrix \mathbf{M} in equation
953953
$\mathbf{M} \boldsymbol{x} = \boldsymbol{b}$ can contain very discrepant entries: some may be very
954954
large while others are zero or very small (see also the
955-
[documentation on calculations](../../user_manual/calculations.md)). The same may be true for the
955+
[documentation on calculations](../user_manual/calculations.md)). The same may be true for the
956956
right-hand side of the equation $\boldsymbol{b}$, as well as its solution $\boldsymbol{x}$. In fact,
957957
there may be certain rows $i$ for which both $\left|\boldsymbol{b}\left[i\right]\right|$ and
958958
$\sum_j \left|\mathbf{M}\left[i,j\right]\right| \left|\boldsymbol{x}\left[j\right]\right|$ are small

docs/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ examples/Transformer Examples.ipynb
9696
examples/Generic Branch Example.ipynb
9797
```
9898

99+
```{toctree}
100+
:caption: "Algorithms"
101+
:maxdepth: 2
102+
algorithms/lu-solver
103+
```
104+
99105
```{toctree}
100106
:caption: "Advanced documentation"
101107
:maxdepth: 2
@@ -104,7 +110,6 @@ advanced_documentation/build-guide
104110
advanced_documentation/c-api
105111
advanced_documentation/core-design
106112
advanced_documentation/python-wrapper-design
107-
advanced_documentation/algorithms/index.md
108113
```
109114

110115
```{toctree}

0 commit comments

Comments
 (0)