Update transformer catalogue and parameters (#2)

RoseauTechnologies · Nov 29, 2024 · a1b3402 · a1b3402
1 parent 54c3e44
commit a1b3402
Show file tree

Hide file tree

Showing 25 changed files with 238 additions and 889 deletions.
diff --git a/.vscode/cspell.json b/.vscode/cspell.json
@@ -0,0 +1,94 @@
+{
+  // Version of the setting file.  Always 0.2
+  "version": "0.2",
+  // language - current active spelling language
+  "language": "en,fr",
+  // words - list of words to be always considered correct
+  "words": [
+    "abcn",
+    "absolufy",
+    "acsr",
+    "aldrey",
+    "asarray",
+    "astype",
+    "bline",
+    "bnline",
+    "bnpline",
+    "bysource",
+    "cohl",
+    "cosgini",
+    "cterm",
+    "curmg",
+    "cython",
+    "direc",
+    "dline",
+    "dropna",
+    "dtype",
+    "elmlodmv",
+    "elmpvsys",
+    "furo",
+    "gpslat",
+    "gpslon",
+    "gscale",
+    "htmlcov",
+    "ilini",
+    "imiso",
+    "inom",
+    "isort",
+    "mathjax",
+    "mathrm",
+    "mlei",
+    "nbsphinx",
+    "ndarray",
+    "nlnph",
+    "nneutral",
+    "noloadloss",
+    "normhkva",
+    "nphase",
+    "nphases",
+    "nplin",
+    "opendss",
+    "pcutr",
+    "pgini",
+    "phasor",
+    "phasors",
+    "phtech",
+    "pipx",
+    "plini",
+    "pmatrix",
+    "pmax",
+    "pyproj",
+    "pyproject",
+    "pytest",
+    "pyupgrade",
+    "qgini",
+    "qlini",
+    "qurs",
+    "raphson",
+    "rline",
+    "rnline",
+    "rnpline",
+    "rtol",
+    "sgini",
+    "slini",
+    "strn",
+    "susceptance",
+    "transfo",
+    "uknom",
+    "uktr",
+    "ureg",
+    "utrn",
+    "xline",
+    "xlpe",
+    "xnet",
+    "xnline",
+    "xnpline",
+    "yesqa"
+  ],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": [
+    "hte"
+  ]
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "esbenp.prettier-vscode",
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+  ],
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,33 @@
+{
+  // Jupyter Notebook
+  "jupyter.notebookFileRoot": "${workspaceFolder}",
+  "notebook.formatOnSave.enabled": true,
+  "notebook.codeActionsOnSave": {
+    "source.organizeImports.ruff": "explicit",
+  },
+
+  // Python
+  "python.analysis.diagnosticSeverityOverrides": {
+    "reportInvalidStringEscapeSequence": "warning",
+    "reportImportCycles": "warning",
+    "reportUnusedImport": "warning",
+  },
+  "python.testing.pytestEnabled": true,
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.organizeImports.ruff": "explicit",
+    },
+  },
+  // Prettier
+  "prettier.printWidth": 120,
+  "[markdown][yaml][html][css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+  },
+  // Json
+  "[json]": {
+    "editor.indentSize": 2,
+  },
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,44 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "options": { "cwd": "${workspaceFolder}" },
+  "presentation": {
+    "showReuseMessage": true,
+    "clear": true,
+  },
+  "tasks": [
+    {
+      "label": "Build docs",
+      "detail": "Build the docs using Sphinx.",
+      "type": "shell",
+      "command": "make -C doc html",
+      "group": {
+        "kind": "build",
+        "isDefault": true,
+      },
+      "problemMatcher": [],
+      "presentation": {
+        "reveal": "silent",
+        "focus": true,
+      },
+    },
+    {
+      "label": "Open docs",
+      "detail": "Open the docs in the browser.",
+      "type": "shell",
+      "command": "open build/html/index.html",
+      "presentation": {
+        "reveal": "never",
+        "close": true,
+        "focus": false,
+        "panel": "dedicated",
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true,
+      },
+      "isBackground": true,
+    },
+  ],
+}
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,7 +31,6 @@ dependencies = [
     "pandas>=1.4.0",
     "geopandas>=1.0.0",
     "shapely>=2.0.0",
-    "regex>=2022.1.18",
     "pint>=0.21.0",
     "typing-extensions>=4.6.2",
     "pyproj>=3.3.0",
@@ -57,6 +56,8 @@ dev = [
     "pytest-cov>=5.0.0",
     "pytest-xdist>=3.1.0",
     "coverage[toml]>=7.0.5",
+    "networkx>=3.4.2",
+    "matplotlib>=3.9.2",
 ]
 
 [tool.uv]

diff --git a/roseau/load_flow_single/__init__.py b/roseau/load_flow_single/__init__.py
@@ -15,22 +15,24 @@
     __status__,
     __url__,
 )
-from roseau.load_flow_single.models.branches import AbstractBranch
-from roseau.load_flow_single.models.buses import Bus
-from roseau.load_flow_single.models.core import Element
-from roseau.load_flow_single.models.lines import Line, LineParameters
-from roseau.load_flow_single.models.loads import (
+from roseau.load_flow_single.models import (
+    AbstractBranch,
     AbstractLoad,
+    Bus,
     Control,
     CurrentLoad,
+    Element,
     FlexibleParameter,
     ImpedanceLoad,
+    Line,
+    LineParameters,
     PowerLoad,
     Projection,
+    Switch,
+    Transformer,
+    TransformerParameters,
+    VoltageSource,
 )
-from roseau.load_flow_single.models.sources import VoltageSource
-from roseau.load_flow_single.models.switches import Switch
-from roseau.load_flow_single.models.transformers import Transformer, TransformerParameters
 from roseau.load_flow_single.network import ElectricalNetwork
 
 __version__ = importlib.metadata.version("roseau-load-flow-single")

diff --git a/roseau/load_flow_single/models/__init__.py b/roseau/load_flow_single/models/__init__.py
@@ -1,19 +1,14 @@
+from roseau.load_flow import Projection, TransformerParameters
 from roseau.load_flow_single.models.branches import AbstractBranch
 from roseau.load_flow_single.models.buses import Bus
 from roseau.load_flow_single.models.core import Element
-from roseau.load_flow_single.models.lines import Line, LineParameters
-from roseau.load_flow_single.models.loads import (
-    AbstractLoad,
-    Control,
-    CurrentLoad,
-    FlexibleParameter,
-    ImpedanceLoad,
-    PowerLoad,
-    Projection,
-)
+from roseau.load_flow_single.models.flexible_parameters import Control, FlexibleParameter
+from roseau.load_flow_single.models.line_parameters import LineParameters
+from roseau.load_flow_single.models.lines import Line
+from roseau.load_flow_single.models.loads import AbstractLoad, CurrentLoad, ImpedanceLoad, PowerLoad
 from roseau.load_flow_single.models.sources import VoltageSource
 from roseau.load_flow_single.models.switches import Switch
-from roseau.load_flow_single.models.transformers import Transformer, TransformerParameters
+from roseau.load_flow_single.models.transformers import Transformer
 
 __all__ = [
     "Element",

diff --git a/...ingle/models/loads/flexible_parameters.py → ...flow_single/models/flexible_parameters.py b/...ingle/models/loads/flexible_parameters.py → ...flow_single/models/flexible_parameters.py
diff --git a/...ad_flow_single/models/lines/parameters.py → ...oad_flow_single/models/line_parameters.py b/...ad_flow_single/models/lines/parameters.py → ...oad_flow_single/models/line_parameters.py
diff --git a/...au/load_flow_single/models/lines/lines.py → roseau/load_flow_single/models/lines.py b/...au/load_flow_single/models/lines/lines.py → roseau/load_flow_single/models/lines.py
@@ -9,7 +9,7 @@
 from roseau.load_flow_engine.cy_engine import CyShuntLine, CySimplifiedLine
 from roseau.load_flow_single.models.branches import AbstractBranch
 from roseau.load_flow_single.models.buses import Bus
-from roseau.load_flow_single.models.lines.parameters import LineParameters
+from roseau.load_flow_single.models.line_parameters import LineParameters
 
 logger = logging.getLogger(__name__)
 

diff --git a/roseau/load_flow_single/models/lines/__init__.py b/roseau/load_flow_single/models/lines/__init__.py
diff --git a/...au/load_flow_single/models/loads/loads.py → roseau/load_flow_single/models/loads.py b/...au/load_flow_single/models/loads/loads.py → roseau/load_flow_single/models/loads.py
diff --git a/roseau/load_flow_single/models/loads/__init__.py b/roseau/load_flow_single/models/loads/__init__.py
diff --git a/roseau/load_flow_single/models/tests/test_buses.py b/roseau/load_flow_single/models/tests/test_buses.py
@@ -104,6 +104,7 @@ def test_voltage_limits():
     bus.max_voltage_level = None
 
     # Bad values
+    bus.nominal_voltage = 400
     bus.min_voltage_level = 0.95
     with pytest.raises(RoseauLoadFlowException) as e:
         bus.max_voltage_level = 0.92
@@ -185,7 +186,7 @@ def test_propagate_limits():  # noqa: C901
 
     lp_mv = LineParameters(id="lp_mv", z_line=1.0, y_shunt=0.1)
     lp_lv = LineParameters(id="lp_lv", z_line=1.0)
-    tp = TransformerParameters.from_catalogue(name="SE_Minera_A0Ak_100kVA", manufacturer="SE")
+    tp = TransformerParameters.from_catalogue(name="SE Minera A0Ak 100kVA 15/20kV(20) 410V Dyn11")
 
     Line(id="l1_mv", bus1=b1_mv, bus2=b2_mv, length=1.5, parameters=lp_mv)
     Line(id="l2_mv", bus1=b2_mv, bus2=b3_mv, length=2, parameters=lp_mv)
@@ -341,7 +342,7 @@ def test_get_connected_buses():
 
     lp_mv = LineParameters(id="lp_mv", z_line=1.0, y_shunt=0.1)
     lp_lv = LineParameters(id="lp_lv", z_line=1.0)
-    tp = TransformerParameters.from_catalogue(name="SE_Minera_A0Ak_100kVA", manufacturer="SE")
+    tp = TransformerParameters.from_catalogue(name="SE Minera A0Ak 100kVA 15/20kV(20) 410V Dyn11")
 
     Line(id="l1_mv", bus1=b1_mv, bus2=b2_mv, length=1.5, parameters=lp_mv)
     Line(id="l2_mv", bus1=b2_mv, bus2=b3_mv, length=2, parameters=lp_mv)

diff --git a/roseau/load_flow_single/models/tests/test_flexible_parameters.py b/roseau/load_flow_single/models/tests/test_flexible_parameters.py
@@ -1,5 +1,3 @@
-import warnings
-
 import numpy as np
 import pytest
 
@@ -56,14 +54,14 @@ def test_control():
     assert e.value.code == RoseauLoadFlowExceptionCode.BAD_CONTROL_VALUE
 
     # Warning if values provided to useless values
-    with warnings.catch_warnings(record=True) as records:
+    with pytest.warns(
+        UserWarning,
+        match=(
+            r"Some voltage norm value\(s\) will not be used by the 'p_max_u_production' control. "
+            r"Nevertheless, values different from 0 were given: 'u_min' \(2.0 V\), 'u_down' \(1.0 V\)"
+        ),
+    ):
         Control(type="p_max_u_production", u_min=2, u_down=1, u_up=240, u_max=250)
-    assert len(records) == 1
-    assert (
-        records[0].message.args[0] == "Some voltage norm value(s) will not be used by the 'p_max_u_production' "
-        "control. Nevertheless, values different from 0 were given: 'u_min' (2.0 V), 'u_down' (1.0 V)"
-    )
-    assert records[0].category is UserWarning
 
     # Bad control value for p_max_u_consumption
     with pytest.raises(RoseauLoadFlowException) as e:
@@ -102,15 +100,14 @@ def test_control():
     assert e.value.code == RoseauLoadFlowExceptionCode.BAD_CONTROL_VALUE
 
     # Warning if values provided to useless values
-    with warnings.catch_warnings(record=True) as records:
+    with pytest.warns(
+        UserWarning,
+        match=(
+            r"Some voltage norm value\(s\) will not be used by the 'p_max_u_consumption' control. "
+            r"Nevertheless, values different from 0 were given: 'u_max' \(-1.0 V\), 'u_up' \(2.3 V\)"
+        ),
+    ):
         Control(type="p_max_u_consumption", u_min=210, u_down=220, u_up=2.3, u_max=-1)
-    assert len(records) == 1
-    assert (
-        records[0].message.args[0] == "Some voltage norm value(s) will not be used by the 'p_max_u_consumption' "
-        "control. Nevertheless, values different from 0 were given: 'u_max' (-1.0 "
-        "V), 'u_up' (2.3 V)"
-    )
-    assert records[0].category is UserWarning
 
     # Bad control value for q_u
     with pytest.raises(RoseauLoadFlowException) as e:

diff --git a/roseau/load_flow_single/models/tests/test_line_parameters.py b/roseau/load_flow_single/models/tests/test_line_parameters.py
@@ -691,8 +691,8 @@ def test_equality():
 
     other_data = {
         "id": lp.id + " other",
-        "z_line": lp.z_line.m + 1,
-        "y_shunt": lp.y_shunt.m + 1,
+        "z_line": lp.z_line.m + 1j,
+        "y_shunt": lp.y_shunt.m + 1j,
         "ampacity": lp.ampacity.m + 1,
         "line_type": LineType.OVERHEAD,
         "material": Material.CU,