Skip to content

Commit 6447b3e

Browse files
Fix several issues in the documentation (#441)
- Document ground connections - Document all supported unbalance calculation definitions - Replace mentions of the deprecated method `rlf.ElectricalNetwork.from_dgs` - Document that constant current loads are not allowed on a short-circuited bus similar to constant power loads - Improve the short circuit example - Fix mistakes detected by GitHub copilot --------- Co-authored-by: Benoît Vinot <benoit.vinot@roseautechnologies.com>
1 parent c7052f1 commit 6447b3e

14 files changed

Lines changed: 267 additions & 215 deletions

doc/Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ $ python -m pip install roseau-load-flow
4747
````
4848

4949
`````{tip}
50-
It is recommended to work in a virtual environment to isolate your project. Create and activate a virtual environment
50+
Working in a virtual environment is recommended to isolate your project. Create and activate a virtual environment
5151
before installing the package. You can create one with:
5252
5353
````{tab} Windows

doc/_static/Ground.svg

Lines changed: 1 addition & 1 deletion
Loading

doc/advanced/Floating_Neutral.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ electrical components. As a result, some appliances may receive excessive voltag
2424
power. In severe cases, outlets can become dangerously energized with full phase-to-phase voltage, posing a significant
2525
risk of equipment damage, electric shock, or fire.
2626

27-
With a perfectly balanced load, the neutral current is zero and the neutral voltage is zero as well. With an unbalanced
28-
load, the neutral current is non-zero. In this case, it is the role of the neutral to balance the voltage across the
29-
electrical phases. In a floating neutral situation, the phase-to-phase voltages remain normal, but the 0V reference of
30-
the neutral gets lost. The larger the load imbalance, the more serious the issue becomes.
27+
With a perfectly balanced load, both the neutral current and voltage are zero. With an unbalanced load, the neutral
28+
current is non-zero. In this case, it is the role of the neutral to balance the voltage across the electrical phases. In
29+
a floating neutral situation, the phase-to-phase voltages remain normal, but the 0V reference of the neutral gets lost.
30+
The larger the load imbalance, the more serious the issue becomes.
3131

3232
## Modelling floating neutral in Roseau Load Flow
3333

doc/advanced/Solvers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ myst:
2020
## General information
2121

2222
The goal is to compute the voltages at each bus and the currents and powers flow in each branch of the network. The
23-
computation must respect the Kirchhoff's laws and the constraints of the network.
23+
computation must respect Kirchhoff's laws and the constraints of the network.
2424

2525
More formally, this is done by solving a system of $n$ nonlinear equations with $n$ variables:
2626

doc/images/Ground.tex

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,40 @@
11
\input{Preamble}%
22

33
\begin{document}
4-
\ctikzset{european, straight voltages, cute inductors}%
4+
\ctikzset{european, straight voltages, cute inductors, label/align=straight}%
55
\begin{tikzpicture}[%
66
show background rectangle,%
77
tight background,%
88
background rectangle/.style={fill=white}%
99
]
1010

11-
\coordinate (g) at (0,0);
11+
\coordinate (g) at (0,0);%
12+
\coordinate (g top) at (0,1.5);%
1213
\node[ground] at (g) {};%
1314
\node[left] at (g) {$\underline{V_{\grm}}$};%
14-
\draw (0, 1) to[short, i=$\underline{I_{\grm}}$, -*] (g);
15+
\draw (g top) to[short, i=$\underline{I_{\grm}}$, *-*] (g);
16+
17+
\draw (g top) ++(155:1.25) coordinate (v1 bottom) ++(155:2) coordinate (v1);%
18+
\node[above] at (v1) {$\underline{V_1}$};%
19+
\draw (v1) to[generic, l_=$\underline{Z_1}$, *-] (v1 bottom) %
20+
to[short, i_=$\underline{I_1}$, current/distance=0.2] (g top);%
21+
22+
\draw (g top) ++(125:1.25) coordinate (v2 bottom) ++(125:2) coordinate (v2);%
23+
\node[above] at (v2) {$\underline{V_2}$};%
24+
\draw (v2) to[generic, l_=$\underline{Z_2}$, *-] (v2 bottom)%
25+
to[short, i=$\underline{I_2}$, current/distance=0.2] (g top);%
26+
27+
\draw (g top) ++(55:1.25) coordinate (vkm1 bottom) ++(55:2) coordinate (vkm1);%
28+
\node[above] at (vkm1) {$\underline{V_{k-1}}$};%
29+
\draw (vkm1) to[generic,l=$\underline{Z_{k-1}}$, *-] (vkm1 bottom) %
30+
to[short, i_=$\underline{I_{k-1}}$, current/distance=0.2] (g top);%
31+
32+
\draw (g top) ++(25:1.25) coordinate (vk bottom) ++(25:2) coordinate (vk);%
33+
\node[above] at (vk) {$\underline{V_k}$};%
34+
\draw (vk) to[generic,l=$\underline{Z_k}$, *-] (vk bottom) %
35+
to[short, i=$\underline{I_k}$, current/distance=0.2] (g top);%
36+
37+
\draw[->,-{Latex[]}, dashed] (g top) +(120:3) arc (120:60:3);%
1538

1639
\end{tikzpicture}
1740
\end{document}

doc/models/Bus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ myst:
1717
## Definition
1818

1919
It represents a multiphase node in the network that other elements (loads, lines, transformers, voltage sources...) can
20-
connect to. A bus is a placeholder point where we want the voltage to be computed during the load flow.
20+
connect to. A bus is a node where the voltage is computed during the load flow analysis.
2121

2222
```{image} /_static/Bus.svg
2323
---

0 commit comments

Comments
 (0)