Merge pull request #406 from RoseauTechnologies/develop

Version 0.13.0

Author: benoit9126

.github/workflows/ci.yml

@@ -19,18 +19,24 @@ env:
   UV_SYSTEM_PYTHON: 1
   COVERAGE_CORE: sysmon
 
+permissions: {}
+
 jobs:
   build:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13"] #, "3.13t", "3.14-dev"] # waiting for pyproj support
+
+    permissions:
+      contents: read
 
     steps:
       - uses: actions/checkout@v4
         with:
           lfs: false
+          persist-credentials: false
 
       - name: Create LFS file list
         run: git lfs ls-files -l | cut -d' ' -f1 | sort > .lfs-assets-id
@@ -52,7 +58,7 @@ jobs:
           git lfs prune --verify-remote
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
 

.github/workflows/pre-commit.yml

@@ -14,13 +14,18 @@ on:
       - ".vscode/**"
       - ".idea/**"
 
+permissions: {}
+
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - uses: actions/checkout@v4
         with:
           lfs: false
+          persist-credentials: false
       - uses: actions/setup-python@v5
         with:
           python-version: "3.13"

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 exclude: ^.idea/|.vscode/
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-json
       - id: check-merge-conflict
@@ -11,13 +11,28 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.6.6
+    rev: 0.8.14
     hooks:
       - id: uv-lock
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.33.3
+    hooks:
+      - id: check-github-workflows
+      - id: check-dependabot
+      - id: check-readthedocs
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.35.6
+    hooks:
+      - id: typos
+        args: [--force-exclude]
+  - repo: https://github.com/woodruffw/zizmor-pre-commit
+    rev: v1.12.1
+    hooks:
+      - id: zizmor
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.10
+    rev: v0.12.11
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: [--fix]
       - id: ruff-format
   - repo: https://github.com/adamchainz/blacken-docs
@@ -26,14 +41,34 @@ repos:
       - id: blacken-docs
         files: ^doc/.*\.md$
         args: [-l 90]
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-pyproject
+          - mdformat-myst
+          - mdformat-gfm
+          - mdformat-gfm-alerts
+          # - mdformat-ruff
+          - mdformat-config
+          - mdformat-deflist
+        exclude: ^.github/.*\.md$
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: v3.5.3
+    rev: v3.6.2
     hooks:
       - id: prettier
         args: ["--print-width", "120"]
         require_serial: true
+        types_or: [yaml]
   - repo: https://github.com/cmhughes/latexindent.pl
-    rev: V3.24.4
+    rev: V3.24.7
     hooks:
       - id: latexindent
         args: [-l, -m, -s, -wd]
+  - repo: https://github.com/biomejs/pre-commit
+    rev: v2.2.2
+    hooks:
+      - id: biome-check
+        types_or: [json, html, css]
+        files: ".*" # Override default files regex that excludes html, rely on `types_or` instead

.vscode/settings.json

@@ -7,11 +7,6 @@
   },
 
   // Python
-  "python.analysis.diagnosticSeverityOverrides": {
-    "reportInvalidStringEscapeSequence": "warning",
-    "reportImportCycles": "warning",
-    "reportUnusedImport": "warning",
-  },
   "python.testing.pytestEnabled": true,
   "[python]": {
     "editor.defaultFormatter": "charliermarsh.ruff",
@@ -22,12 +17,14 @@
   },
   // Prettier
   "prettier.printWidth": 120,
-  "[markdown][yaml][html][css]": {
+  "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
   },
-  // Json
-  "[json]": {
+  // Biome
+  "[json][html][css]": {
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.formatOnSave": true,
     "editor.indentSize": 2,
   },
 }

LICENSE.md

@@ -2,27 +2,22 @@ BSD 3-Clause License
 
 Copyright (c) 2018, Roseau Technologies
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+   disclaimer.
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+   disclaimer in the documentation and/or other materials provided with the distribution.
 
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
+   derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -18,39 +18,38 @@ _Roseau Load Flow_ is a powerful load flow solver and static analysis tool that
 In addition to the following **unique** set of features:
 
 - Support for _floating neutrals_ for loads and sources
-- Four-wire multi-phase modelling with no Kron's reduction, no transformations, no assumptions on the
-  network topology and no implicit earthing everywhere
-- Support for **flexible**, voltage-dependent, loads directly in the Newton algorithm for better
-  convergence and stability
+- Four-wire multi-phase modelling with no Kron's reduction, no transformations, no assumptions on the network topology
+  and no implicit earthing everywhere
+- Support for **flexible**, voltage-dependent, loads directly in the Newton algorithm for better convergence and
+  stability
 
 <!-- end rlf-pitch -->
 
-This project is compatible with Python version 3.10 and newer. The
-[installation instructions](https://roseau-load-flow.roseautechnologies.com/en/latest/Installation.html)
-will guide you through the installation process. If you are new to _Roseau Load Flow_, we recommend
-you start with the
-[getting started tutorial](https://roseau-load-flow.roseautechnologies.com/en/latest/usage/Getting_Started.html).
-You can find the complete documentation at https://roseau-load-flow.roseautechnologies.com/.
+This project is compatible with Python version 3.11 and newer. The
+[installation instructions](https://roseau-load-flow.roseautechnologies.com/en/latest/Installation.html) will guide you
+through the installation process. If you are new to _Roseau Load Flow_, we recommend you start with the
+[getting started tutorial](https://roseau-load-flow.roseautechnologies.com/en/latest/usage/Getting_Started.html). You
+can find the complete documentation at https://roseau-load-flow.roseautechnologies.com/.
 
 ## License
 
 This project is _partially_ open source but using the solver requires a license. The license key
-`A8C6DA-9405FB-E74FB9-C71C3C-207661-V3` can be used free of charge with networks containing up to 10
-buses. To obtain a personal or commercial license, please contact us
-at [contact@roseautechnologies.com](mailto:contact@roseautechnologies.com).
+`A8C6DA-9405FB-E74FB9-C71C3C-207661-V3` can be used free of charge with networks containing up to 10 buses. To obtain a
+personal or commercial license, please contact us at
+[contact@roseautechnologies.com](mailto:contact@roseautechnologies.com).
 
 > [!NOTE]
-> Licenses are given free of charge for **students and teachers**. Please contact us at
-> contact@roseautechnologies.com for more information.
+> Licenses are given free of charge for **students and teachers**. Please contact us at contact@roseautechnologies.com
+> for more information.
 
 Read more at [License](https://roseau-load-flow.roseautechnologies.com/en/latest/License.html).
 
 ## Network data
 
 <!-- start rlf-networks -->
 
-_Roseau Load Flow_ ships with a sample of 20 low-voltage and 20 medium-voltage feeder networks. Each
-network is provided with its summer and winter load points.
+_Roseau Load Flow_ ships with a sample of 20 low-voltage and 20 medium-voltage feeder networks. Each network is provided
+with its summer and winter load points.
 
 To go further, you can also use
 [these 150 distribution networks](https://www.data.gouv.fr/fr/datasets/departs-hta-representatifs-pour-lanalyse-des-reseaux-de-distribution-francais/),
@@ -74,5 +73,4 @@ This software is developed by [Roseau Technologies](https://www.roseautechnologi
 
 Follow us on:
 [![Linkedin](https://i.sstatic.net/gVE0j.png) LinkedIn](https://www.linkedin.com/company/roseau-technologies/)
-&nbsp;
 [![GitHub](https://i.sstatic.net/tskMh.png) GitHub](https://github.com/RoseauTechnologies)

biome.jsonc

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.2.2/schema.json",
+  "vcs": {
+    "enabled": false,
+    "clientKind": "git",
+    "useIgnoreFile": false
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "maxSize": 2097152 // 2 MiB to accommodate the networks Catalogue.html file (1.6 MiB)
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 120,
+    "lineEnding": "lf"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "double"
+    }
+  },
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  "html": {
+    "formatter": {
+      "enabled": true // Enable experimental HTML formatting
+    }
+  }
+}

doc/Bibliography.bib

@@ -1,3 +1,4 @@
+
 @article{Klimek_2020,
     doi = {10.21468/scipostphys.9.4.053},
     url = {https://doi.org/10.21468%2Fscipostphys.9.4.053},