Flexible load documentation ++

.pre-commit-config.yaml

@@ -17,11 +17,11 @@ repos:
     hooks:
       - id: poetry-check
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.7.0 # keep in sync with pyproject.toml
+    rev: 23.9.1 # keep in sync with pyproject.toml
     hooks:
       - id: black-jupyter
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.286 # keep in sync with pyproject.toml
+    rev: v0.0.290 # keep in sync with pyproject.toml
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]
@@ -32,9 +32,9 @@ repos:
       - id: blacken-docs
         entry: bash -c "blacken-docs -l 90 $(find doc/ -name '*.md')"
         args: [-l 90]
-        additional_dependencies: [black==23.7.0] # keep in sync with black above
+        additional_dependencies: [black==23.9.1] # keep in sync with black above
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.2
+    rev: v3.0.3
     hooks:
       - id: prettier
         args: ["--print-width", "120"]

conda/environment.yml

@@ -12,4 +12,5 @@ dependencies:
   - pint >=0.21.0
   - requests >=2.28.1
   - typing-extensions >=4.6.2
-  - rich >=13.5.2
+  - rich >=13.5.1
+  - matplotlib >=3.7.2

conda/meta.yaml

@@ -35,6 +35,7 @@ requirements:
     - requests >=2.28.1
     - typing-extensions >=4.6.2
     - rich >=13.5.1
+    - matplotlib >=3.7.2
 
 test:
   imports:

doc/Changelog.md

@@ -5,6 +5,13 @@
 **In development**
 
 - {gh-pr}`132` {gh-issue}`101` Document extra utilities including converters and constants.
+- {gh-pr}`131` {gh-issue}`127` Improve the documentation of the flexible loads.
+  - Add the method `compute_powers` method to the `FlexibleParameter` class to compute the resulting flexible powers
+    for a given theoretical power and a list of voltage norms.
+  - Add the `plot_control_p`, `plot_control_q` and `plot_pq` methods to the `FlexibleParameter` class to plot the
+    control curves and control trajectories.
+  - Add the extra `plot` to install `matplotlib` alongside `roseau-load-flow`.
+- {gh-pr}`131` Correction of a bug in the error message of the powers setter method.
 - {gh-pr}`130` Mark some internal attributes as private, they were previously marked as public.
 - {gh-pr}`128` Add the properties `z_line`, `y_shunt` and `with_shunt` to the `Line` class.
 - {gh-pr}`125` Speed-up build of conda workflow using mamba.

doc/Installation.md

@@ -50,6 +50,13 @@ To upgrade to the latest version (recommended), use:
 $ python -m pip install --upgrade roseau-load-flow
 ```
 
+Moreover, using the `pip` installation, some plot functions requires additional dependencies that are not installed by
+default. If you need these functions, you can install the `plot` extra using
+
+```console
+$ python -m pip install roseau-load-flow[plot]
+```
+
 ## Using `conda`
 
 `roseau-load-flow` is also available on [conda-forge](https://anaconda.org/conda-forge/roseau-load-flow).