Merge pull request #233 from RoseauTechnologies/develop

Version 0.9.1

Author: benoit9126

.pre-commit-config.yaml

@@ -15,15 +15,15 @@ repos:
     hooks:
       - id: poetry-check
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.10
+    rev: v0.5.0
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]
         args: [--fix]
       - id: ruff-format
         types_or: [python, pyi, jupyter]
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
+    rev: 1.18.0
     hooks:
       - id: blacken-docs
         files: ^doc/.*\.md$

.vscode/cspell.json

@@ -8,38 +8,78 @@
     "abcn",
     "absolufy",
     "acsr",
+    "aldrey",
     "asarray",
     "astype",
+    "bline",
+    "bnline",
+    "bnpline",
     "bysource",
+    "cohl",
+    "cosgini",
+    "cterm",
+    "curmg",
     "cython",
+    "direc",
+    "dline",
     "dropna",
     "dtype",
+    "elmlodmv",
+    "elmpvsys",
     "furo",
+    "gscale",
     "htmlcov",
+    "ilini",
+    "imiso",
+    "inom",
     "isort",
     "mathjax",
     "mathrm",
+    "mlei",
     "nbsphinx",
     "ndarray",
+    "nlnph",
+    "nneutral",
     "noloadloss",
     "normhkva",
+    "nphase",
     "nphases",
     "nplin",
     "opendss",
+    "pcutr",
+    "pgini",
     "phasor",
+    "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

doc/Changelog.md

@@ -17,6 +17,33 @@ og:description: See what's new in the latest release of Roseau Load Flow !
 
 # Changelog
 
+## Version 0.9.1
+
+```{note}
+The wheels for Windows are temporarily unavailable anymore. If you need them, please post an issue on GitHub.
+```
+
+- {gh-pr}`231` Add `LineParameters.from_power_factory` and `TransformerParameters.from_power_factory`
+  methods to easily import PowerFactory lines and transformer models into Roseau Load Flow.
+- {gh-pr}`230` Improve the algorithm for assigning potential references for DGS networks.
+- {gh-pr}`229` Several fixes and improvements to the PowerFactory import:
+
+  - Update the "Export Definition Folder" bundled with _Roseau Load Flow_ as a pfd file;
+  - Support lines with missing type ID. This is the case when the `TypLne` objects are inherited
+    from an external library in PowerFactory and not included in the project being exported; A
+    `LineParameters` object is automatically created for these lines;
+  - Support "General Load (`ElmLod`)" elements;
+  - Preserve Geometry information on buses and branches;
+  - Improve handling of phases of several elements. Previously, phases were hard-coded.
+  - Fix the unit of the power of static generators;
+  - Fix the re-sizing of the matrices of line types without neutral elements;
+  - Fix the total power of "MV Loads (`ElmLodmv`)" to take into account the generation power;
+  - Fix all loads to no longer ignore the scale factor of the power;
+  - Fix the sign of the reactive power of MV and LV loads
+  - Fix the ground connection to the source bus
+
+  And many more...
+
 ## Version 0.9.0
 
 - {gh-pr}`227` Sources and loads are now allowed to have floating neutrals. This means that a load/source

doc/conf.py

@@ -23,7 +23,7 @@
 
 # The full version, including alpha/beta/rc tags
 version = "0.9"
-release = "0.9.0"
+release = "0.9.1"
 
 # -- General configuration ---------------------------------------------------
 

doc/models/Line/Parameters.md

@@ -541,10 +541,10 @@ Please note that for underground lines, the provided height $h$ must be negative
 ...     line_type=rlf.LineType.UNDERGROUND,
 ...     conductor_type=rlf.ConductorType.AL,
 ...     insulator_type=rlf.InsulatorType.PVC,
-...     section=150, #mm²
-...     section_neutral=70, #mm²
-...     height=-1.5, # m # Underground so negative!
-...     external_diameter=0.049, #m
+...     section=150,  # mm²
+...     section_neutral=70,  # mm²
+...     height=-1.5,  # m # Underground so negative!
+...     external_diameter=0.049,  # m
 ... )
 
 >>> line_parameters.z_line

doc/usage/Catalogues.md

@@ -304,7 +304,7 @@ the values in different units. For instance, if you want to get transformer para
 nominal power of 3150 kVA, the following two commands return the same table:
 
 ```pycon
->>> rlf.TransformerParameters.get_catalogue(sn=3150e3) # in VA by default
+>>> rlf.TransformerParameters.get_catalogue(sn=3150e3)  # in VA by default
 
 >>> import roseau.load_flow as rlf
 ... rlf.TransformerParameters.get_catalogue(sn=rlf.Q_(3150, "kVA"))
@@ -484,7 +484,9 @@ the method `get_catalogue` to narrow down the result to a single line in the cat
 For instance, these parameters filter the results down to a single line parameters:
 
 ```pycon
->>> rlf.LineParameters.from_catalogue(line_type="underground", conductor_type="al", section=240)
+>>> rlf.LineParameters.from_catalogue(
+...     line_type="underground", conductor_type="al", section=240
+... )
 LineParameters(id='U_AL_240')
 ```
 
@@ -520,7 +522,7 @@ to create line parameters with different numbers of phases using the `nb_phases`
 In case no or several results match the parameters, an error is raised:
 
 ```pycon
->>> rlf.LineParameters.from_catalogue(name= r"U_AL.*")
+>>> rlf.LineParameters.from_catalogue(name=r"U_AL.*")
 RoseauLoadFlowException: Several line parameters matching the query (name='U_AL.*') have been found:
 'U_AL_19', 'U_AL_20', 'U_AL_22', 'U_AL_25', 'U_AL_28', 'U_AL_29', 'U_AL_33', 'U_AL_34', 'U_AL_37',
 'U_AL_38', 'U_AL_40', 'U_AL_43', 'U_AL_48', 'U_AL_50', 'U_AL_54', 'U_AL_55', 'U_AL_59', 'U_AL_60',

doc/usage/Connecting_Elements.md

@@ -116,7 +116,7 @@ the new load.
 
 ```pycon
 >>> new_bus = rlf.Bus(id="new_bus", phases="abcn")
->>> new_load = rlf.PowerLoad(id="new_load", bus=new_bus, phases="an", powers=[6e3]) # W
+>>> new_load = rlf.PowerLoad(id="new_load", bus=new_bus, phases="an", powers=[6e3])  # W
 ```
 
 At this point, they don't belong to any network:

doc/usage/Data_Exchange.md

@@ -27,20 +27,21 @@ for Geographical Informations Systems_ (DGS) JSON format.
 
 The following components are currently supported:
 
-| Name       | Description                | RLF Element                 |
-| ---------- | -------------------------- | --------------------------- |
-| ElmXnet    | External Grid              | VoltageSource               |
-| ElmTerm    | Terminal                   | Bus                         |
-| StaCubic   | Cubicle                    | N/A _(included in the bus)_ |
-| ElmTr2     | 2-Winding Transformer      | Transformer                 |
-| TypTr2     | 2-Winding Transformer Type | TransformerParameters       |
-| ElmCoup    | Switch                     | Switch                      |
-| ElmLne     | Line/Cable                 | Line                        |
-| TypLne     | Line/Cable Type            | LineParameters              |
-| ElmLodLV   | Load, low voltage          | PowerLoad (P>=0)            |
-| ElmLodmv   | Load, medium voltage       | PowerLoad (P>=0)            |
-| ElmGenStat | Static Generator           | PowerLoad (P<=0)            |
-| ElmPvsys   | PV System                  | PowerLoad (P<=0)            |
+| Name       | Description                | RLF Element             |
+| ---------- | -------------------------- | ----------------------- |
+| ElmXnet    | External Grid              | VoltageSource           |
+| ElmTerm    | Terminal                   | Bus                     |
+| StaCubic   | Cubicle                    | N/A                     |
+| ElmTr2     | 2-Winding Transformer      | Transformer             |
+| TypTr2     | 2-Winding Transformer Type | TransformerParameters   |
+| ElmCoup    | Switch                     | Switch                  |
+| ElmLne     | Line/Cable                 | Line                    |
+| TypLne     | Line/Cable Type            | LineParameters          |
+| ElmLodLV   | Load, low voltage          | PowerLoad (P>=0)        |
+| ElmLodmv   | Load, medium voltage       | PowerLoad (P>=0 or P<0) |
+| ElmLod     | General load               | PowerLoad (P>=0)        |
+| ElmGenStat | Static Generator           | PowerLoad (P<=0)        |
+| ElmPvsys   | PV System                  | PowerLoad (P<=0)        |
 
 ### Export from PowerFactory
 
@@ -105,6 +106,19 @@ Please note that there are some limitations in the supported features:
 - **Ignored attributes**: functionality that is not yet available in `roseau-load-flow` is ignored.
   This includes the state of the switches (switches are considered to be always closed);
 
+### Lines and Transformers
+
+In addition to the DGS import support, `roseau-load-flow` supports creating lines and transformers
+parameters from PowerFactory data. This is useful when you don't want to import a whole network but
+would like to use some of the lines and transformers models you have in a power factory project.
+
+To create line parameters from a PowerFactory Line Type (`TypLne`) object, use the
+{meth}`LineParameters.from_power_factory() roseau.load_flow.LineParameters.from_power_factory` method.
+
+To create transformer parameters from a PowerFactory 2-Winding Transformer Type (`TypTr2`) object, use the
+{meth}`TransformerParameters.from_power_factory() roseau.load_flow.TransformerParameters.from_power_factory`
+method.
+
 ## OpenDSS
 
 `roseau-load-flow` supports creating lines and transformers from OpenDSS data.

doc/usage/Extras.md

@@ -156,10 +156,10 @@ use the {meth}`~roseau.load_flow.models.Bus.res_voltage_unbalance` method on a 3
 the Voltage Unbalance Factor (VUF) as per the IEC definition:
 
 ```{math}
-VUF = \frac{|V_n|}{|V_p|} * 100 (\%)
+VUF = \frac{|V_{\mathrm{n}}|}{|V_{\mathrm{p}}|} \times 100 (\%)
 ```
 
-Where $V_n$ is the negative-sequence voltage and $V_p$ is the positive-sequence voltage.
+Where $V_{\mathrm{n}}$ is the negative-sequence voltage and $V_{\mathrm{p}}$ is the positive-sequence voltage.
 
 ```{note}
 Other definitions of voltage unbalance could be added in the future. If you need a specific

doc/usage/Flexible_Loads.md

@@ -179,7 +179,11 @@ As a consequence, the provided apparent power for phase `'a'` is the maximum tha
 ...     bus=load_bus3,
 ...     phases="abcn",
 ...     powers=[si, 0, 0],  # W
-...     flexible_params=[fp, rlf.FlexibleParameter.constant(), rlf.FlexibleParameter.constant()],
+...     flexible_params=[
+...         fp,
+...         rlf.FlexibleParameter.constant(),
+...         rlf.FlexibleParameter.constant(),
+...     ],
 ... )
 ```
 
@@ -239,14 +243,24 @@ production is totally shut down.
 >>> # Let's try with PQ(u) control, by injecting reactive power before reducing active power
 ... en.loads["load3"].disconnect()
 ... fp = rlf.FlexibleParameter.pq_u_production(
-...     up_up=240, up_max=250, uq_min=200, uq_down=210, uq_up=235, uq_max=240, s_max=4000  # V and VA
+...     up_up=240,
+...     up_max=250,
+...     uq_min=200,
+...     uq_down=210,
+...     uq_up=235,
+...     uq_max=240,
+...     s_max=4000,  # V and VA
 ... )
 ... flexible_load = rlf.PowerLoad(
 ...     id="load3",
 ...     bus=load_bus3,
 ...     phases="abcn",
 ...     powers=[si, 0, 0],
-...     flexible_params=[fp, rlf.FlexibleParameter.constant(), rlf.FlexibleParameter.constant()],
+...     flexible_params=[
+...         fp,
+...         rlf.FlexibleParameter.constant(),
+...         rlf.FlexibleParameter.constant(),
+...     ],
 ... )
 ```