Merge pull request #180 from RoseauTechnologies/develop

Version 0.7.0

.github/workflows/ci.yml

@@ -5,8 +5,14 @@ on:
     branches: [main, develop]
     tags:
       - "*"
+    paths-ignore:
+      - "doc/**"
+      - ".vscode/**"
   pull_request:
     branches: [main, develop]
+    paths-ignore:
+      - "doc/**"
+      - ".vscode/**"
 
 env:
   CI: true
@@ -28,7 +34,7 @@ jobs:
         run: git lfs ls-files -l | cut -d' ' -f1 | sort > .lfs-assets-id
 
       - name: Cache git LFS
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .git/lfs
           key: git-lfs-v1-${{ matrix.python-version }}-${{ hashFiles('.lfs-assets-id') }}

.gitignore

@@ -249,3 +249,4 @@ doc/images/*.pdf
 
 roseau/*
 !roseau/load_flow
+node_modules/

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
     hooks:
       - id: poetry-check
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.14 # keep in sync with pyproject.toml
+    rev: v0.2.1
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]
@@ -30,7 +30,8 @@ repos:
         args: [-l 90]
         additional_dependencies: [black==23.12.1]
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.1.0
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         args: ["--print-width", "120"]
+        require_serial: true

README.md

@@ -1,7 +1,6 @@
 # Roseau Load Flow
 
 ![CI](https://github.com/RoseauTechnologies/Roseau_Load_Flow/workflows/CI/badge.svg)
-[![Documentation](https://github.com/RoseauTechnologies/Roseau_Load_Flow/actions/workflows/doc.yml/badge.svg)](https://github.com/RoseauTechnologies/Roseau_Load_Flow/actions/workflows/doc.yml)
 [![pre-commit](https://github.com/RoseauTechnologies/Roseau_Load_Flow/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/RoseauTechnologies/Roseau_Load_Flow/actions/workflows/pre-commit.yml)
 
 _Roseau Load Flow_ is a highly capable three-phase load flow solver with an ergonomic Python API

doc/Changelog.md

@@ -1,12 +1,24 @@
 # Changelog
 
-## Version 0.7.0-alpha
+## 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
 a standalone Python library.
 ```
 
+- 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.
+- {gh-pr}`178` {gh-issue}`176` Merge the `results_to_json`, `results_from_json`, `results_to_dict`
+  and `results_from_dict` methods of the `ElectricalNetwork` and `Element`s classes into the methods
+  `to_json`, `from_json`, `to_dict` and `from_dict` respectively. The old `results_` methods are
+  **deprecated** and will be removed in a future release. The new methods will include the results by
+  default, but you can pass `include_results=False` to exclude them.
+- {gh-pr}`175` {gh-issue}`174` Fix JSON serialization of network with line parameters created from the
+  catalogue.
+- {gh-pr}`173` Remove the conda installation option.
 - {gh-pr}`168` {gh-issue}`166` Fix initial potentials' propagation.
 - {gh-pr}`167` {gh-issue}`161` Add a catalogue of lines using the IEC standards. You can use the method
   `LineParameters.get_catalogue()` to get a data frame of the available lines and the method

doc/Installation.md

@@ -104,38 +104,6 @@ In [1]: %pip install roseau-load-flow
 
 This installs the package in the correct environment for the active notebook kernel.
 
-## 3. Using `conda`
-
-Installations using `conda` is temporarily unavailable. Please use `pip` instead.
-
-<!--
-`roseau-load-flow` is also available on [conda-forge](https://anaconda.org/conda-forge/roseau-load-flow).
-It can be installed using conda with:
-
-````{tab} Windows
-
-```doscon
-C:> conda install -c conda-forge roseau-load-flow
-```
-
-````
-
-````{tab} Linux/MacOS
-
-```console
-$ conda install -c conda-forge roseau-load-flow
-```
-
-````
-
-This installs the package and all its required and optional dependencies.
-
-```{tip}
-If you use *conda* to manage your project, it is recommended to use the `conda` package manager
-instead of `pip`.
-```
--->
-
 <!-- Local Variables: -->
 <!-- mode: markdown -->
 <!-- coding: utf-8-unix -->

doc/License.md

@@ -23,7 +23,7 @@ Licenses are given **free of charge** for _students and teachers_. Please contac
 There are two ways to activate the license in your project:
 
 1. Set the environment variable `ROSEAU_LOAD_FLOW_LICENSE_KEY` to the license key. When this
-   environment variable is defined, it will be automatically used by the solver to validate the
+   environment variable is defined, it will automatically be used by the solver to validate the
    license, no further action is required.
    **This is the recommended approach.**
    ```{note}

doc/conf.py

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

doc/usage/Connecting_Elements.md

@@ -1,8 +1,10 @@
-# (Dis)Connecting elements
+(usage-modifying-network)=
+
+# Modifying a network
 
 ## Creating a network
 
-Let's take the electrical network of the [Getting started page](usage-getting-started).
+Let's take the electrical network of the [Getting started page](usage-getting-started) as an example.
 
 ```pycon
 >>> import numpy as np
@@ -89,15 +91,14 @@ UserWarning: The results of this element may be outdated. Please re-run a load f
 ```
 
 ```{danger}
-The load element `load` doesn't belong to a network and a part of its results is not accessible any more. `res_`
-methods may raise errors.
+The load element `load` doesn't belong to a network and a some of its results are not accessible
+anymore. Accessing `res_` properties may raise errors.
 ```
 
 ## Connecting an element
 
-Let's create a new line and a new load at the end of this line.
-
-The new bus and the new load are created first.
+Let's extend the network with a new line and add a load at its end. First, we create a new bus and
+the new load.
 
 ```pycon
 >>> new_bus = Bus(id="new_bus", phases="abcn")
@@ -175,7 +176,7 @@ a voltage source.
 
 ### Modifying a voltage source
 
-You can change the voltage of the voltage source:
+You can change the voltage of the voltage source using the `voltages` attribute:
 
 ```pycon
 >>> vs.voltages
@@ -222,10 +223,10 @@ For a line, you can also change the length:
 ```pycon
 >>> line.length
 2.0 <Unit('kilometer')>
->>> line.length = 1.0
+>>> line.length = 1.0  # <-- shorten the line by half
 >>> line.length
 1.0 <Unit('kilometer')>
->>> line.z_line  # <-- the impedance is divided by 2
+>>> line.z_line  # <-- the impedance gets divided by 2
 array([[0.5+0.1j, 0. +0.j , 0. +0.j , 0. +0.j ],
        [0. +0.j , 0.5+0.1j, 0. +0.j , 0. +0.j ],
        [0. +0.j , 0. +0.j , 0.5+0.1j, 0. +0.j ],