Merge pull request #228 from RoseauTechnologies/develop

Version 0.9.0

Author: benoit9126

.gitattributes

@@ -1,4 +1,5 @@
 *.pdf filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
 *.ico filter=lfs diff=lfs merge=lfs -text
+*.pfd filter=lfs diff=lfs merge=lfs -text
 .vscode/*.json linguist-language=jsonc

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,10 +13,10 @@ A clear and concise description of what the bug is.
 Minimal Working Example to understand the problem
 
 ```python
-from roseau.load_flow import *
+import roseau.load_flow as rlf
 
 # Your code here
-# Please do not add username, password or API keys here
+# PLEASE DO NOT ADD LICENSE KEYS HERE
 ```
 
 **Expected behavior**
@@ -27,9 +27,9 @@ A clear and concise description of what you expected to happen.
 Please copy/paste here the output of the function `show_versions`
 
 ```python
-from roseau.load_flow import show_versions
+import roseau.load_flow as rlf
 
-show_versions()
+rlf.show_versions()
 ```
 
 ```

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
     hooks:
       - id: poetry-check
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
+    rev: v0.4.10
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]
@@ -28,14 +28,14 @@ repos:
       - id: blacken-docs
         files: ^doc/.*\.md$
         args: [-l 90]
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v4.0.0-alpha.8
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.3.2
     hooks:
       - id: prettier
         args: ["--print-width", "120"]
         require_serial: true
   - repo: https://github.com/cmhughes/latexindent.pl
-    rev: V3.23.9
+    rev: V3.24.2
     hooks:
       - id: latexindent
         args: [-l, -m, -s, -wd]

.vscode/cspell.json

@@ -21,7 +21,11 @@
     "mathrm",
     "nbsphinx",
     "ndarray",
+    "noloadloss",
+    "normhkva",
+    "nphases",
     "nplin",
+    "opendss",
     "phasor",
     "pipx",
     "pmatrix",

doc/Changelog.md

@@ -17,6 +17,43 @@ og:description: See what's new in the latest release of Roseau Load Flow !
 
 # Changelog
 
+## Version 0.9.0
+
+- {gh-pr}`227` Sources and loads are now allowed to have floating neutrals. This means that a load/source
+  with `phases="abcn"` can now be connected to a bus with `phases="abc"`.
+- {gh-pr}`225` The `calculate_voltages` function now accepts and return pint quantities.
+- MacOS wheels for roseau-load-flow-engine are now published on PyPI. This means that `pip install roseau-load-flow`
+  should now work on macOS.
+- Added support for running in Google Colab documents.
+- Fixed a bug in license checks caching on Windows.
+- Added support for Numpy 2.0.
+- {gh-issue}`222` {gh-pr}`223` `from_catalogue()` methods of the electrical network and transformer
+  and line parameters now perform "full match" comparison on textual inputs. If you need the old
+  behavior, use regular expression wild cards `.*` in the input string.
+- {gh-issue}`220` {gh-pr}`221` Add `LineParameters.from_open_dss` and `TransformerParameters.from_open_dss` methods to
+  easily import OpenDSS lines and transformer models into Roseau Load Flow. More information is
+  available in the documentation of these methods.
+- {gh-issue}`210` {gh-pr}`219` Add a parameter to `LineParameters.from_catalogue` to choose the number
+  of phases of the created line parameters object.
+- {gh-pr}`218` Add `Transformer.res_power_losses` to get the total power losses in a transformer.
+- {gh-pr}`217` Add an ID override to `TransformerParameters.from_catalogue` similar to
+  `LineParameters.from_catalogue`.
+- {gh-issue}`216` {gh-pr}`217` **BREAKING CHANGE**: Rename the `id` parameter of `TransformerParameters`
+  catalogue methods to `name` to be consistent with `LineParameters`.
+  **If you call these methods by keyword arguments**, make sure to update your usage of
+  `TransformerParameters.from_catalogue(id="xxx")` to `TransformerParameters.from_catalogue(name="xxx")`.
+- {gh-pr}`212` **BREAKING CHANGE**: Modify the constructor of `TransformerParameters` to take the `z2`
+  and `ym` parameters directly instead of the open and short circuit tests parameters. You can still
+  create an object from these tests using the `from_open_and_short_circuit_tests` constructor. This
+  change comes with other changes to `TransformerParameters`, notably:
+  - The `z2`, `ym`, `k`, and `orientation` are now always available as attributes on the instance
+  - The `to_zyk` method is deprecated in favour of the direct attribute access on the instance. This
+    method will be removed in a future version
+  - The parameters `i0`, `p0`, `psc`, and `vsc` are now optional. They return None for instances
+    created using `z2` and `ym` directly
+  - The JSON representation of `TransformerParameters` has changed, but it is still compatible with
+    the old representation.
+
 ## Version 0.8.1
 
 - {gh-issue}`214` Solve a bug in the engine when using delta connected flexible loads.

doc/License.md

@@ -61,9 +61,9 @@ There are two ways to activate the license in your project:
 
    ```python
    from pathlib import Path
-   import roseau.load_flow as lf
+   import roseau.load_flow as rlf
 
-   lf.activate_license(Path("my_license_key.txt").read_text().strip())
+   rlf.activate_license(Path("my_license_key.txt").read_text().strip())
 
    # Rest of your code here
    ```

doc/_static/IO/DGS_Export_Window.png

@@ -22,8 +22,8 @@
 # author = "Benoît Vinot"
 
 # The full version, including alpha/beta/rc tags
-version = "0.8"
-release = "0.8.1"
+version = "0.9"
+release = "0.9.0"
 
 # -- General configuration ---------------------------------------------------
 

doc/_static/IO/DGS_How_To_Export.png

@@ -32,16 +32,16 @@ A bus is identified by its unique id and must define the phases it is connected
 have all the phases of the elements connected to it.
 
 ```python
-from roseau.load_flow import Bus, PowerLoad
+import roseau.load_flow as rlf
 
-bus1 = Bus(id="bus1", phases="abcn")  # A three-phase bus with a neutral
-bus2 = Bus(id="bus2", phases="abc")  # A three-phase bus without a neutral
-bus3 = Bus(id="bus3", phases="an")  # A single-phase bus
+bus1 = rlf.Bus(id="bus1", phases="abcn")  # A three-phase bus with a neutral
+bus2 = rlf.Bus(id="bus2", phases="abc")  # A three-phase bus without a neutral
+bus3 = rlf.Bus(id="bus3", phases="an")  # A single-phase bus
 
-PowerLoad(id="load1", bus=bus1, powers=[100, 0, 50j], phases="abcn")  # OK
-PowerLoad(id="load2", bus=bus1, powers=[100, 0, 50j], phases="abc")  # OK
-PowerLoad(id="load3", bus=bus2, powers=[100], phases="ab")  # OK
-PowerLoad(
+rlf.PowerLoad(id="load1", bus=bus1, powers=[100, 0, 50j], phases="abcn")  # OK
+rlf.PowerLoad(id="load2", bus=bus1, powers=[100, 0, 50j], phases="abc")  # OK
+rlf.PowerLoad(id="load3", bus=bus2, powers=[100], phases="ab")  # OK
+rlf.PowerLoad(
     id="load4", bus=bus3, powers=[100], phases="ab"
 )  # Error: bus3 does not have phase "b"
 ```
@@ -50,10 +50,10 @@ Since a bus represents a point in the network, it is possible to define the coor
 point:
 
 ```python
+import roseau.load_flow as rlf
 from shapely import Point
-from roseau.load_flow import Bus
 
-bus = Bus(id="bus", phases="abc", geometry=Point(1.0, -2.5))
+bus = rlf.Bus(id="bus", phases="abc", geometry=Point(1.0, -2.5))
 ```
 
 This information is not used by the load flow solver but could be used to generate geographical
@@ -69,37 +69,29 @@ Here is an example of a simple short-circuit between two phases:
 ```python
 import functools as ft
 import numpy as np
-from roseau.load_flow import (
-    Bus,
-    ElectricalNetwork,
-    Line,
-    LineParameters,
-    PotentialRef,
-    Q_,
-    VoltageSource,
-)
+import roseau.load_flow as rlf
 
 # Two buses
-bus1 = Bus(id="bus1", phases="abcn")
-bus2 = Bus(id="bus2", phases="abcn")
+bus1 = rlf.Bus(id="bus1", phases="abcn")
+bus2 = rlf.Bus(id="bus2", phases="abcn")
 
 # A line
-lp = LineParameters(id="lp", z_line=Q_((0.3 + 0.35j) * np.eye(4), "ohm/km"))
-line = Line(id="line", bus1=bus1, bus2=bus2, parameters=lp, length=Q_(1, "km"))
+lp = rlf.LineParameters(id="lp", z_line=rlf.Q_((0.3 + 0.35j) * np.eye(4), "ohm/km"))
+line = rlf.Line(id="line", bus1=bus1, bus2=bus2, parameters=lp, length=rlf.Q_(1, "km"))
 
 # A voltage source on the first bus
 un = 400 / np.sqrt(3)
-voltages = Q_(un * np.exp([0, -2j * np.pi / 3, 2j * np.pi / 3]), "V")
-vs = VoltageSource(id="source", bus=bus1, voltages=voltages)
+voltages = rlf.Q_(un * np.exp([0, -2j * np.pi / 3, 2j * np.pi / 3]), "V")
+vs = rlf.VoltageSource(id="source", bus=bus1, voltages=voltages)
 
 # The neutral of the voltage source is fixed at potential 0
-pref = PotentialRef(id="pref", element=bus1, phase="n")
+pref = rlf.PotentialRef(id="pref", element=bus1, phase="n")
 
 # Create a short-circuit on bus2 between phases "a" and "b"
 bus2.add_short_circuit("a", "b")
 
 # Create a network and solve a load flow
-en = ElectricalNetwork.from_element(bus1)
+en = rlf.ElectricalNetwork.from_element(bus1)
 en.solve_load_flow()
 
 # Get the currents flowing to the line from bus1