Merge pull request #208 from RoseauTechnologies/develop

Version 0.8.0

Author: benoit9126

.github/workflows/pre-commit.yml

@@ -24,4 +24,4 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
-      - uses: pre-commit/action@v3.0.0
+      - uses: pre-commit/action@v3.0.1

.gitignore

@@ -250,3 +250,5 @@ doc/images/*.pdf
 roseau/*
 !roseau/load_flow
 node_modules/
+doc/images/**/*.bak*
+doc/images/**/*.pdf

.latexindent.yaml

@@ -0,0 +1,46 @@
+defaultIndent: "  "
+
+maxNumberOfBackUps: 0
+onlyOneBackUp: 1
+backupExtension: .tex.bak
+
+removeTrailingWhitespace:
+  beforeProcessing: 0
+  afterProcessing: 1
+
+indentAfterItems:
+  itemize: 1
+  enumerate: 1
+  description: 1
+  list: 1
+
+noAdditionalIndentGlobal:
+  keyEqualsValuesBracesBrackets: 1
+
+indentAfterHeadings:
+  section:
+    indentAfterThisHeading: 1
+    level: 2
+  subsection:
+    indentAfterThisHeading: 1
+    level: 4
+  subsection*:
+    indentAfterThisHeading: 1
+    level: 4
+  subsubsection:
+    indentAfterThisHeading: 1
+    level: 6
+
+indentRules:
+  chapter: "  "
+  section: "  "
+  item: "  "
+
+modifyLineBreaks:
+  textWrapOptions:
+    columns: 120
+  environments:
+    BeginStartsOnOwnLine: 1
+    BodyStartsOnOwnLine: 1
+    EndStartsOnOwnLine: 1
+    EndFinishesWithLineBreak: 1

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: ^.idea/|.vscode/|^conda/meta.yaml
+exclude: ^.idea/|.vscode/
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
@@ -11,11 +11,11 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/python-poetry/poetry
-    rev: 1.7.0
+    rev: 1.8.0
     hooks:
       - id: poetry-check
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.2.1
+    rev: v0.3.3
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]
@@ -28,10 +28,14 @@ repos:
       - id: blacken-docs
         files: ^doc/.*\.md$
         args: [-l 90]
-        additional_dependencies: [black==23.12.1]
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         args: ["--print-width", "120"]
         require_serial: true
+  - repo: https://github.com/cmhughes/latexindent.pl
+    rev: V3.23.7
+    hooks:
+      - id: latexindent
+        args: [-l, -m, -s, -wd]

.vscode/cspell.json

@@ -2,7 +2,7 @@
   // Version of the setting file.  Always 0.2
   "version": "0.2",
   // language - current active spelling language
-  "language": "en",
+  "language": "en,fr",
   // words - list of words to be always considered correct
   "words": [
     "abcn",

README.md

@@ -13,8 +13,8 @@ will guide you through the installation process. If you are new to _Roseau Load
 You can find the complete documentation at https://roseau-load-flow.roseautechnologies.com/.
 
 > [!IMPORTANT]
-> Starting with version 0.7.0, Roseau Load Flow will no longer be supplied as a SaaS. The software will
-> be available as a standalone Python library.
+> Starting with version 0.7.0, Roseau Load Flow is no longer supplied as a SaaS. The software is now
+> available as a standalone Python library.
 
 ## License
 

doc/.htaccess

@@ -0,0 +1,12 @@
+RewriteEngine On
+
+# WWW -> no-WWW
+RewriteCond %{HTTP_HOST} ^www\.(.*)$ [NC]
+RewriteRule ^ https://%1%{REQUEST_URI} [R=301,L,NE,QSA]
+
+# HTTP -> HTTPS
+RewriteCond %{HTTPS} off
+RewriteRule ^ https://%{HTTP_HOST}%{REQUEST_URI} [R=301,L,NE,QSA]
+
+# HSTS
+Header set Strict-Transport-Security "max-age=10886400; includeSubDomains; preload"

doc/Changelog.md

@@ -1,13 +1,62 @@
+---
+myst:
+  html_meta:
+    "description lang=en": |
+      Release History of Roseau Load Flow - Three-phase unbalanced load flow solver in a Python API by Roseau
+      Technologies.
+    "description lang=fr": |
+      Historique des versions de Roseau Load Flow - Solveur d'écoulement de charge triphasé et déséquilibré dans une
+      API Python par Roseau Technologies.
+    "keywords lang=fr": version, solveur, simulation, réseau, électrique, bus
+    "keywords lang=en": changelog, solver, simulation, distribution grid, bus, model
+---
+
 # Changelog
 
+## Version 0.8.0
+
+- {gh-pr}`207` Fix a bug in the zig-zag three-phase transformer model that led to incorrect active power flow in the
+  transformer. The bug affected the 50 kVA transformers that have the type `Yzn11` in the catalogue.
+- {gh-pr}`206` {gh-issue}`187` Un-deprecate `results_to_dict/json` methods and remove deprecated
+  `results_from_dict/json` methods.
+- {gh-pr}`205` {gh-issue}`200` Fix error when propagating the potentials from a voltage source with fewer phases
+  than the bus.
+- {gh-pr}`204` {gh-issue}`193` Remove restrictions on geometry types. Allow specifying the CRS of the geometries.
+- {gh-pr}`203` {gh-issue}`186` Detect invalid element overrides when connecting a new element with the
+  same ID and type of an existing element.
+- {gh-pr}`202` {gh-issue}`188` Explicitly prevent instantiation of abstract classes.
+- {gh-pr}`201` {gh-issue}`185` Add `type` attribute to the load classes and rename branches `branch_type`
+  attribute to `type` for consistency. Please replace `branch.branch_type` by `branch.type` in your code.
+  In addition, loads data frames gained two new columns:
+  1. `type` indicating the load type: constant-(`power`, `current`, `impedance`);
+  2. and `flexible` indicating if the load is flexible.
+- {gh-pr}`197` Fix a bug in three-phase transformer models that led to excessive reactive power flow in the transformer.
+- {gh-pr}`199` Add Schneider Electric EcoDesign transformers to the catalogue. These are tagged with the _AA0Ak_
+  efficiency class. Other internal data have been added to the catalogue for testing purposes.
+- {gh-pr}`198` Simplify the storage of the transformer catalogues. This is an internal change that should not have
+  effects on user code.
+- {gh-pr}`196` {gh-issue}`194` Improve the error message when accessing `res_flexible_powers` on a non-flexible load
+  and relax the flexible parameters plotting methods to accept an array-like of voltages.
+- {gh-pr}`195` Use `latexindent.pl` to automatically indent LaTeX files in the documentation.
+- {gh-pr}`192` Speed up results access by up to 3x using several optimization techniques. This is especially
+  noticeable in timeseries simulations and when accessing results of large networks.
+- {gh-pr}`184` Improve the documentation to have a better SEO (sitemap, metadata and canonical URLs). The navigation
+  menu has also been improved.
+- {gh-pr}`183` {gh-issue}`181` Update the networks catalogue to better represent the real networks.
+  LV loads are made single-phase, MV sources are connected in delta, and MV buses lost their neutral.
+  Voltage, current, and power limits are added to the buses, lines, and transformers.
+  The line parameters IDs are also updated to match the new line parameters catalogue.
+- {gh-pr}`182` Improve the error message when trying to access results on the network before running the load flow.
+- {gh-pr}`189` Allow flexible loads to have a null active theoretical power.
+
 ## Version 0.7.0
 
 ```{important}
-Starting with version 0.7.0, Roseau Load Flow will no longer be supplied as a SaaS. The software will be available as
+Starting with version 0.7.0, Roseau Load Flow is no longer supplied as a SaaS. The software is now available as
 a standalone Python library.
 ```
 
-- The documentation is moved from GitHub Pages to https://www.roseau-load-flow.roseautechnologies.com/.
+- The documentation is moved from GitHub Pages to <https://www.roseau-load-flow.roseautechnologies.com/>.
 - Fix a bug in the engine: it was impossible to change the parameters of center-tapped and single phase transformers.
 - {gh-pr}`179` Fix a bug in the propagation of potentials when a center-tapped transformer is used without neutral at
   the primary side.
@@ -137,7 +186,7 @@ a standalone Python library.
 - {gh-pr}`93` Add short-circuit computation.
 - {gh-pr}`92`
   - Add the changelog in the documentation.
-  - Use NodeJs 20 in the Dockerfile.
+  - Use Node.js 20 in the Dockerfile.
   - Correction of a dead link in the README.
 
 ## Version 0.4.0
@@ -183,7 +232,7 @@ a standalone Python library.
 
 <!-- Local Variables: -->
 <!-- mode: gfm -->
-<!-- fill-column: 100 -->
+<!-- fill-column: 120 -->
 <!-- coding: utf-8 -->
 <!-- ispell-local-dictionary: "british" -->
 <!-- End: -->

doc/Installation.md

@@ -1,3 +1,18 @@
+---
+myst:
+  html_meta:
+    "description lang=en": |
+      Installation of Roseau Load Flow in a Python environment - Simulation of smart and unbalanced electrical
+      distribution networks.
+    "description lang=fr": |
+      Installation de Roseau Load Flow dans un environnement Python - Simulation des réseaux de distribution
+      électriques intelligents et déséquilibrés.
+    "keywords lang=fr": |
+      Roseau, load flow, python, écoulement de charge, écoulement de puissance, réseau de distribution, triphasé,
+      déséquilibré
+    "keywords lang=en": Roseau, Load flow, python, power flow, distribution grid, three-phase, multiphase, unbalanced
+---
+
 # Installation
 
 Please select one of the following installation methods that best suits your workflow.
@@ -8,7 +23,7 @@ If you are a beginner in Python, please note that the commands below must be exe
 to the Python console prompt `>>>`.
 ```
 
-## 1. Using `pip`
+## Using `pip`
 
 `roseau-load-flow` is available on [PyPI](https://pypi.org/project/roseau-load-flow/). It can be
 installed using pip with:
@@ -30,7 +45,8 @@ $ python -m pip install roseau-load-flow
 ````
 
 `````{tip}
-It is recommended to work in a virtual environment to isolate your project. Create and activate a virtual environment before installing the package. You can create one with:
+It is recommended to work in a virtual environment to isolate your project. Create and activate a virtual environment
+before installing the package. You can create one with:
 
 ````{tab} Windows
 
@@ -93,7 +109,7 @@ the corresponding functions. They can be installed with the
 1. `plot`: installs _matplotlib_ for the plotting functions
 2. `graph` installs _networkx_ for graph theory analysis functions
 
-## 2. Using `pip` in Jupyter Notebooks
+## Using `pip` in Jupyter Notebooks
 
 If you are using Jupyter Notebooks, you can install `roseau-load-flow` directly from a notebook
 cell with:

doc/License.md

@@ -1,12 +1,30 @@
-(license)=
+---
+myst:
+  html_meta:
+    "description lang=en": |
+      Depending on your status, Roseau Load Flow is available with several types of free or paid licences. A trial
+       key is also available.
+    "description lang=fr": |
+      En fonction de votre statut, Roseau Load Flow est disponible avec plusieurs types de licences gratuites ou
+       payantes. Une clef d'essai est également disponible.
+    "keywords lang=fr": solveur, simulation, réseau, électrique, licence, open-source, gratuit, essai
+    "keywords lang=en": simulation, distribution grid, solver, open-source, free, test
+---
 
-# License
+(license-page)=
+
+# Get and activate your licence
+
+(license-types)=
+
+## Commercial and free licences
 
 This project is partially open source. The source code of this repository is available under the
 [BSD 3-Clause License](https://github.com/RoseauTechnologies/Roseau_Load_Flow/blob/main/LICENSE.md).
 
 The solver used in this project is not open source. A license has to be purchased to use it. To
-obtain a personal or commercial license, please contact us at contact@roseautechnologies.com.
+obtain a personal or commercial license, please contact us at
+[contact@roseautechnologies.com](mailto:contact@roseautechnologies.com).
 
 For networks with less than 11 buses (up to 10 buses), the license key `A8C6DA-9405FB-E74FB9-C71C3C-207661-V3`
 can be used free of charge. For example, this key can be used to follow the getting started guide.