Merge remote-tracking branch 'origin/main' into dependabot/github_actions/SonarSource/sonarqube-scan-action-5

Author: Thijss

docs/demos/connecting_new_consumer.ipynb

@@ -178,7 +178,7 @@
     "    # Set the new feeder ids\n",
     "    grid.set_feeder_ids()\n",
     "\n",
-    "    # Update the loadflow\n",
+    "    # Update the power flow\n",
     "    core_interface = PowerGridModelInterface(grid=grid)\n",
     "\n",
     "    core_interface.create_input_from_grid()\n",

docs/examples/model/grid_extensions_examples.ipynb

@@ -11,7 +11,7 @@
     "\n",
     "## Adding columns to the Grid arrays\n",
     "\n",
-    "Output variables are not present in the basic Grid as defined in gpm-ds, since these might or might not be useful to specific projects.\n",
+    "Output variables are not present in the basic Grid as defined in pgm-ds, since these might or might not be useful to specific projects.\n",
     "To add these as you please you can extend the definitions of the arrays in your own project.\n"
    ]
   },

docs/examples/pgm/basic_pgm_examples.ipynb

@@ -6,14 +6,14 @@
    "source": [
     "# PGM Calculation Engine Examples\n",
     "\n",
-    "These examples show how to interact with the [power-grid-model](https://github.com/PowerGridModel/power-grid-model) calculation engine to perform load flow calculations. For a detailed documentation on the calculation engine please refer to [power-grid-model docs](https://power-grid-model.readthedocs.io/en/stable/).\n"
+    "These examples show how to interact with the [power-grid-model](https://github.com/PowerGridModel/power-grid-model) calculation engine to perform power flow calculations. For a detailed documentation on the calculation engine please refer to [power-grid-model docs](https://power-grid-model.readthedocs.io/en/stable/).\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Single Load Flow example\n",
+    "## Single Power Flow example\n",
     "\n",
     "We will demonstrate how to use the PGMCoreInterface to perform Power Flow calculations on a `Grid` object.\n",
     "In the examples the `RadialGridGenerator` is used to create randomised input networks.\n"

docs/examples/utils/grid_from_txt_examples.ipynb

@@ -20,7 +20,7 @@
     "If you follow a specific syntax, you can use the input from the\n",
     "graph editor to transfer your drawing to pgm-ds:\n",
     "\n",
-    "- A _source node_ should be prefixed with `S`\n",
+    "- A _substation node_ should be prefixed with `S`\n",
     "  - e.g: `S1`, `S2`\n",
     "- A _line_ is defined as `<from_node> <to_node>`\n",
     "  - From nodes can be both regular nodes and source nodes\n",
@@ -61,7 +61,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -84,29 +84,27 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
     "from power_grid_model_ds import Grid\n",
     "\n",
     "grid = Grid.from_txt(\n",
-    "    [\n",
-    "        \"S1 2\",\n",
-    "        \"S1 3 open\",\n",
-    "        \"2 7\",\n",
-    "        \"3 5\",\n",
-    "        \"3 6 transformer\",\n",
-    "        \"5 7\",\n",
-    "        \"7 8\",\n",
-    "        \"8 9\",\n",
-    "    ]\n",
+    "    \"S1 2\",\n",
+    "    \"S1 3 open\",\n",
+    "    \"2 7\",\n",
+    "    \"3 5\",\n",
+    "    \"3 6 transformer\",\n",
+    "    \"5 7\",\n",
+    "    \"7 8\",\n",
+    "    \"8 9\",\n",
     ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -132,7 +130,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "venv",
    "language": "python",
    "name": "python3"
   },
@@ -146,7 +144,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.1"
+   "version": "3.13.0"
   }
  },
  "nbformat": 4,

docs/model_interface.ipynb

@@ -87,23 +87,25 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "```py\n",
     "target_line = grid.arrays.line.get(1)\n",
-    "grid.make_active(target_branch_array=target_line)\n"
+    "grid.make_active(target_branch_array=target_line)\n",
+    "```\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "As seen above you can also make batch modification using the `grid.append` method.\n",
+    "As seen above, you can also apply multiple modifications in one go using the `grid.append` method.\n",
     "\n",
     "## Array interface\n",
     "\n",
-    "The array container is build around a extension of numpy arrays with the `FancyArray` class. This allows for easy and consistent definition of array types, recognition of array-type from it's class and features which improve readability such as dot-notation and autocompletion. It contains a `._data` attribute with the base numpy array and extra settings can be provided using `._defaults` and `._str_lengths`. Note these values should only be used in defining the array classes and remain private when using the arrays.\n",
+    "The array container is build around an extension of numpy arrays with the `FancyArray` class. This allows for easy and consistent definition of array types, recognition of array-type from its class and features which improve readability such as dot-notation and autocompletion. It contains a `._data` attribute with the base numpy array and extra settings can be provided using `._defaults` and `._str_lengths`. Note these values should only be used in defining the array classes and remain private when using the arrays.\n",
     "\n",
     "### Array definition\n",
     "\n",
-    "You can create your own array by subclassing FancyArray.\n",
+    "You can create your own array by subclassing `FancyArray`.\n",
     "Array-columns can be defined by adding class attributes with the column name and the numpy dtype.\n",
     "\n",
     "Example:\n"
@@ -148,7 +150,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "These are used when initializing an array with the .empty method\n"
+    "These are used when initializing an array with the `.empty` method\n"
    ]
   },
   {
@@ -190,7 +192,7 @@
     "\n",
     "### Array loops\n",
     "\n",
-    "Looping over large arrays can be a performance hit, this is caused by casting each row to the original `FancyArray` subclass. When you want to implement a faster loop over the array you can choose to access the `array.data` directly and create the loop using\n"
+    "Looping over large arrays can incur a performance hit caused by conversion of each element to the original `FancyArray` subclass. When you want to implement a faster loop over the array you can choose to access the `array.data` directly and create the loop using\n"
    ]
   },
   {

docs/quick_start.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Quick Start\n",
     "\n",
-    "In this quick start we create an extension of the Grid object, generate a random instance of it and perform loadflow calculations and modifactions.\n"
+    "In this quick start we create an extension of the Grid object, generate a random instance of it and perform power flow calculations and modifications.\n"
    ]
   },
   {
@@ -15,7 +15,7 @@
    "source": [
     "## Setting up a grid extension\n",
     "\n",
-    "This shows how to add extra values to a `Grid` object. If these are present in the PGM output they will updated after a loadflow calculation.\n"
+    "This shows how to add extra values to a `Grid` object. If these are present in the PGM output they will be updated after a power flow calculation.\n"
    ]
   },
   {
@@ -105,7 +105,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Performing Loadflow calculations\n",
+    "## Performing power flow calculations\n",
     "\n",
     "Using the `PowerGridModelInterface` the `Grid` data can be provided to the calculation engine. Using `update_grid` values can be transferred to the `Grid` object.\n"
    ]
@@ -198,7 +198,7 @@
    "source": [
     "## Analyzing Grid structure\n",
     "\n",
-    "The `Grid` also contains a graph representation which can be used for anayling structure. Such as finding the shortest path between two nodes.\n"
+    "The `Grid` also contains a graph representation which can be used for analyzing structure. Such as finding the shortest path between two nodes.\n"
    ]
   },
   {

src/power_grid_model_ds/_core/load_flow.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-"""Load flow functions and classes"""
+"""Power flow functions and classes"""
 
 from typing import Dict, Optional
 

src/power_grid_model_ds/_core/model/containers/grid_protocol.py

@@ -6,17 +6,19 @@
 
 import dataclasses
 from dataclasses import dataclass
-from typing import Generator
+from typing import TYPE_CHECKING, Generator
 
 import numpy as np
 
 from power_grid_model_ds._core.model.arrays import Branch3Array, BranchArray, NodeArray
 from power_grid_model_ds._core.model.arrays.base.array import FancyArray
 from power_grid_model_ds._core.model.arrays.base.errors import RecordDoesNotExist
-from power_grid_model_ds._core.model.containers.grid_protocol import MinimalGridArrays
 from power_grid_model_ds._core.model.graphs.models import RustworkxGraphModel
 from power_grid_model_ds._core.model.graphs.models.base import BaseGraphModel
 
+if TYPE_CHECKING:  # pragma: no cover
+    from power_grid_model_ds._core.model.grids.base import Grid
+
 
 @dataclass
 class GraphContainer:
@@ -119,7 +121,7 @@ def make_inactive(self, branch: BranchArray) -> None:
             setattr(self, field.name, graph)
 
     @classmethod
-    def from_arrays(cls, arrays: MinimalGridArrays) -> "GraphContainer":
+    def from_arrays(cls, arrays: "Grid") -> "GraphContainer":
         """Build from arrays"""
         cls._validate_branches(arrays=arrays)
 
@@ -132,7 +134,7 @@ def from_arrays(cls, arrays: MinimalGridArrays) -> "GraphContainer":
         return new_container
 
     @staticmethod
-    def _validate_branches(arrays: MinimalGridArrays):
+    def _validate_branches(arrays: "Grid") -> None:
         for array in arrays.branch_arrays:
             if any(~np.isin(array.from_node, arrays.node.id)):
                 raise RecordDoesNotExist(f"Found invalid .from_node values in {array.__class__.__name__}")

src/power_grid_model_ds/_core/model/graphs/container.py

@@ -4,20 +4,22 @@
 
 from abc import ABC, abstractmethod
 from contextlib import contextmanager
-from typing import Generator
+from typing import TYPE_CHECKING, Generator
 
 import numpy as np
 from numpy._typing import NDArray
 
 from power_grid_model_ds._core.model.arrays.pgm_arrays import Branch3Array, BranchArray, NodeArray
-from power_grid_model_ds._core.model.containers.grid_protocol import MinimalGridArrays
 from power_grid_model_ds._core.model.graphs.errors import (
     GraphError,
     MissingBranchError,
     MissingNodeError,
     NoPathBetweenNodes,
 )
 
+if TYPE_CHECKING:  # pragma: no cover
+    from power_grid_model_ds._core.model.grids.base import Grid
+
 
 # pylint: disable=too-many-public-methods
 class BaseGraphModel(ABC):
@@ -327,7 +329,7 @@ def find_fundamental_cycles(self) -> list[list[int]]:
         return [self._internals_to_externals(nodes) for nodes in internal_cycles]
 
     @classmethod
-    def from_arrays(cls, arrays: MinimalGridArrays, active_only=False) -> "BaseGraphModel":
+    def from_arrays(cls, arrays: "Grid", active_only=False) -> "BaseGraphModel":
         """Build from arrays"""
         new_graph = cls(active_only=active_only)