power-grid-model-ds 1.3.3__tar.gz → 1.4.0__tar.gz

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: power-grid-model-ds
-Version: 1.3.3
+Version: 1.4.0
 Summary: Power Grid Model extension which provides a grid data structure for simulation and analysis
 Author-email: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
 License: MPL-2.0

power_grid_model_ds-1.4.0/PYPI_VERSION

@@ -0,0 +1 @@
+1.4.0

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/fancypy.py

@@ -8,6 +8,8 @@ from typing import TYPE_CHECKING, Union
 
 import numpy as np
 
+from power_grid_model_ds._core.utils.misc import array_equal_with_nan
+
 if TYPE_CHECKING:
     from power_grid_model_ds._core.model.arrays.base.array import FancyArray
 
@@ -44,23 +46,5 @@ def sort(array: "FancyArray", axis=-1, kind=None, order=None) -> "FancyArray":
 def array_equal(array1: "FancyArray", array2: "FancyArray", equal_nan: bool = True) -> bool:
     """Return True if two arrays are equal."""
     if equal_nan:
-        return _array_equal_with_nan(array1, array2)
+        return array_equal_with_nan(array1.data, array2.data)
     return np.array_equal(array1.data, array2.data)
-
-
-def _array_equal_with_nan(array1: "FancyArray", array2: "FancyArray") -> bool:
-    # np.array_equal does not work with NaN values in structured arrays, so we need to compare column by column.
-    # related issue: https://github.com/numpy/numpy/issues/21539
-
-    if array1.columns != array2.columns:
-        return False
-
-    for column in array1.columns:
-        column_dtype = array1.dtype[column]
-        if np.issubdtype(column_dtype, np.str_):
-            if not np.array_equal(array1[column], array2[column]):
-                return False
-            continue
-        if not np.array_equal(array1[column], array2[column], equal_nan=True):
-            return False
-    return True

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/load_flow.py

@@ -4,6 +4,7 @@
 
 """Power flow functions and classes"""
 
+import warnings
 from typing import Dict, Optional
 
 import numpy as np
@@ -50,18 +51,29 @@ class PowerGridModelInterface:
         self.grid = grid or Grid.empty()
         self.system_frequency = system_frequency
 
-        self.input_data = input_data or {}
+        self._input_data = input_data or {}
         self.output_data: dict[str, NDArray] = {}
         self.model: Optional[PowerGridModel] = None
 
+    @property
+    def input_data(self) -> Dict[str, NDArray]:
+        """Get the input data for the PowerGridModel."""
+        warnings.warn(
+            "Input data has been made private and will be removed as public properety in a future version. "
+            "Do not use it directly.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self._input_data
+
     def create_input_from_grid(self):
         """
         Create input for the PowerGridModel
         """
         for array_name in PGM_ARRAYS:
             pgm_array = self._create_power_grid_array(array_name=array_name)
-            self.input_data[array_name] = pgm_array
-        return self.input_data
+            self._input_data[array_name] = pgm_array
+        return self._input_data
 
     def create_grid_from_input_data(self, check_ids: bool = True) -> Grid:
         """
@@ -75,9 +87,9 @@ class PowerGridModelInterface:
         Returns a Grid object with the arrays filled with the PowerGridModel input.
         """
         for pgm_name in PGM_ARRAYS:
-            if pgm_name in self.input_data:
+            if pgm_name in self._input_data:
                 pgm_ds_array_class = getattr(self.grid, pgm_name).__class__
-                pgm_ds_array = pgm_ds_array_class(self.input_data[pgm_name])
+                pgm_ds_array = pgm_ds_array_class(self._input_data[pgm_name])
                 self.grid.append(pgm_ds_array, check_max_id=False)
         if check_ids:
             self.grid.check_ids()
@@ -155,6 +167,6 @@ class PowerGridModelInterface:
         return list(set(first_dtype.names).intersection(set(second_dtype.names)))  # type: ignore[arg-type]
 
     def _setup_model(self):
-        self.input_data = self.input_data or self.create_input_from_grid()
-        self.model = PowerGridModel(self.input_data, system_frequency=self.system_frequency)
+        self._input_data = self._input_data or self.create_input_from_grid()
+        self.model = PowerGridModel(self._input_data, system_frequency=self.system_frequency)
         return self.model

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/model/arrays/base/array.py

@@ -323,3 +323,11 @@ class FancyArray(ABC):
         if pandas is None:
             raise ImportError("pandas is not installed")
         return pandas.DataFrame(self._data)
+
+    @classmethod
+    def from_extended(cls: Type[Self], extended: Self) -> Self:
+        """Create an instance from an extended array."""
+        if not isinstance(extended, cls):
+            raise TypeError(f"Extended array must be of type {cls.__name__}, got {type(extended).__name__}")
+        dtype = cls.get_dtype()
+        return cls(data=np.array(extended[list(dtype.names)], dtype=dtype))

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/model/graphs/container.py

@@ -5,7 +5,6 @@
 """Stores the GraphContainer class"""
 
 import dataclasses
-import warnings
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Generator
 
@@ -63,45 +62,18 @@ class GraphContainer:
             graph = getattr(self, field.name)
             graph.add_node_array(node_array=node_array, raise_on_fail=False)
 
-    def add_node(self, node: NodeArray) -> None:
-        """Add a node to all graphs"""
-        warnings.warn(
-            "add_node is deprecated and will be removed in a future release, use add_node_array instead",
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-        self.add_node_array(node_array=node)
-
     def add_branch_array(self, branch_array: BranchArray) -> None:
         """Add a branch to all graphs"""
         for field in self.graph_attributes:
             graph = getattr(self, field.name)
             graph.add_branch_array(branch_array=branch_array)
 
-    def add_branch(self, branch: BranchArray) -> None:
-        """Add a branch to all graphs"""
-        warnings.warn(
-            "add_branch is deprecated and will be removed in a future release, use add_branch_array instead",
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-        self.add_branch_array(branch_array=branch)
-
     def add_branch3_array(self, branch3_array: Branch3Array) -> None:
         """Add a branch to all graphs"""
         for field in self.graph_attributes:
             graph = getattr(self, field.name)
             graph.add_branch3_array(branch3_array=branch3_array)
 
-    def add_branch3(self, branch: Branch3Array) -> None:
-        """Add a branch to all graphs"""
-        warnings.warn(
-            "add_branch3 is deprecated and will be removed in a future release, use add_branch3_array instead",
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-        self.add_branch3_array(branch3_array=branch)
-
     def delete_node(self, node: NodeArray) -> None:
         """Remove a node from all graphs"""
         for field in dataclasses.fields(self):

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/model/graphs/models/base.py

@@ -2,7 +2,6 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-import warnings
 from abc import ABC, abstractmethod
 from contextlib import contextmanager
 from typing import TYPE_CHECKING, Generator
@@ -16,6 +15,7 @@ from power_grid_model_ds._core.model.graphs.errors import (
     MissingNodeError,
     NoPathBetweenNodes,
 )
+from power_grid_model_ds._core.model.utils import _get_branch3_branches
 
 if TYPE_CHECKING:
     from power_grid_model_ds._core.model.grids.base import Grid
@@ -253,23 +253,17 @@ class BaseGraphModel(ABC):
 
         return [self._internals_to_externals(path) for path in internal_paths]
 
-    def get_components(self, substation_nodes: list[int] | None = None) -> list[list[int]]:
-        """Returns all separate components when the substation_nodes are removed of the graph as lists"""
-        if substation_nodes:
-            warnings.warn(
-                message="""
-get_components: substation_nodes argument is deprecated and will be removed in a future release.
-The functionality is still available with the use of the `tmp_remove_nodes` context manager.
-
-Example:
->>> with graph.tmp_remove_nodes(substation_nodes):
->>>    components = graph.get_components()
-""",
-                category=DeprecationWarning,
-                stacklevel=2,
-            )
-        with self.tmp_remove_nodes(substation_nodes or []):
-            internal_components = self._get_components()
+    def get_components(self) -> list[list[int]]:
+        """Returns all separate components when the substation_nodes are removed of the graph as lists
+
+        If you want to get the components of the graph without certain nodes,
+        use the `tmp_remove_nodes` context manager.
+
+        Example:
+        >>> with graph.tmp_remove_nodes(substation_nodes):
+        >>>    components = graph.get_components()
+        """
+        internal_components = self._get_components()
         return [self._internals_to_externals(component) for component in internal_components]
 
     def get_connected(
@@ -421,21 +415,3 @@ Example:
 
     @abstractmethod
     def _all_branches(self) -> Generator[tuple[int, int], None, None]: ...
-
-
-def _get_branch3_branches(branch3: Branch3Array) -> BranchArray:
-    node_1 = branch3.node_1.item()
-    node_2 = branch3.node_2.item()
-    node_3 = branch3.node_3.item()
-
-    status_1 = branch3.status_1.item()
-    status_2 = branch3.status_2.item()
-    status_3 = branch3.status_3.item()
-
-    branches = BranchArray.zeros(3)
-    branches.from_node = [node_1, node_1, node_2]
-    branches.to_node = [node_2, node_3, node_3]
-    branches.from_status = [status_1, status_1, status_2]
-    branches.to_status = [status_2, status_3, status_3]
-
-    return branches

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/model/grids/base.py

@@ -440,6 +440,24 @@ class Grid(FancyArrayContainer):
         set_is_feeder(grid=self)
         set_feeder_ids(grid=self)
 
+    @classmethod
+    def from_extended(cls, extended: "Grid") -> "Grid":
+        """Create a grid from an extended Grid object."""
+        new_grid = cls.empty()
+
+        # Add nodes first, so that branches can reference them
+        new_grid.append(new_grid.node.__class__.from_extended(extended.node))
+
+        for field in dataclasses.fields(cls):
+            if field.name == "node":
+                continue  # already added
+            if issubclass(field.type, FancyArray):
+                extended_array = getattr(extended, field.name)
+                new_array = field.type.from_extended(extended_array)
+                new_grid.append(new_array, check_max_id=False)
+
+        return new_grid
+
 
 def _add_branch_array(branch: BranchArray | Branch3Array, grid: Grid):
     """Add a branch array to the grid"""

power_grid_model_ds-1.4.0/src/power_grid_model_ds/_core/model/utils.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+from power_grid_model_ds._core.model.arrays.pgm_arrays import Branch3Array, BranchArray
+
+
+def _get_branch3_branches(branch3: Branch3Array) -> BranchArray:
+    node_1 = branch3.node_1.item()
+    node_2 = branch3.node_2.item()
+    node_3 = branch3.node_3.item()
+
+    status_1 = branch3.status_1.item()
+    status_2 = branch3.status_2.item()
+    status_3 = branch3.status_3.item()
+
+    branches = BranchArray.zeros(3)
+    branches.from_node = [node_1, node_1, node_2]
+    branches.to_node = [node_2, node_3, node_3]
+    branches.from_status = [status_1, status_1, status_2]
+    branches.to_status = [status_2, status_3, status_3]
+
+    return branches

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/utils/misc.py

@@ -39,3 +39,24 @@ def get_inherited_attrs(cls: Type, *private_attributes):
             retrieved_attributes[private_attr] = attr_dict
 
     return retrieved_attributes
+
+
+def array_equal_with_nan(array1: np.ndarray, array2: np.ndarray) -> bool:
+    """Compare two structured arrays for equality, treating NaN values as equal.
+
+    np.array_equal does not work with NaN values in structured arrays, so we need to compare column by column.
+    related issue: https://github.com/numpy/numpy/issues/21539
+    """
+    if array1.dtype.names != array2.dtype.names:
+        return False
+
+    columns: Sequence[str] = array1.dtype.names
+    for column in columns:
+        column_dtype = array1.dtype[column]
+        if np.issubdtype(column_dtype, np.str_):
+            if not np.array_equal(array1[column], array2[column]):
+                return False
+            continue
+        if not np.array_equal(array1[column], array2[column], equal_nan=True):
+            return False
+    return True

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/visualizer/app.py

@@ -60,6 +60,7 @@ def _get_columns_store(grid: Grid) -> dcc.Store:
             "line": grid.line.columns,
             "link": grid.link.columns,
             "transformer": grid.transformer.columns,
+            "three_winding_transformer": grid.three_winding_transformer.columns,
             "branch": grid.branches.columns,
         },
     )

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds/_core/visualizer/parsers.py

@@ -6,7 +6,8 @@ from typing import Any, Literal
 
 from power_grid_model_ds._core.model.arrays.base.array import FancyArray
 from power_grid_model_ds._core.model.grids.base import Grid
-from power_grid_model_ds.arrays import BranchArray, NodeArray
+from power_grid_model_ds._core.model.utils import _get_branch3_branches
+from power_grid_model_ds.arrays import Branch3Array, BranchArray, NodeArray
 
 
 def parse_node_array(nodes: NodeArray) -> list[dict[str, Any]]:
@@ -32,6 +33,27 @@ def parse_branches(grid: Grid) -> list[dict[str, Any]]:
     parsed_branches.extend(parse_branch_array(grid.line, "line"))
     parsed_branches.extend(parse_branch_array(grid.link, "link"))
     parsed_branches.extend(parse_branch_array(grid.transformer, "transformer"))
+    parsed_branches.extend(parse_branch3_array(grid.three_winding_transformer, "transformer"))
+    return parsed_branches
+
+
+def parse_branch3_array(branches: Branch3Array, group: Literal["transformer"]) -> list[dict[str, Any]]:
+    """Parse the three-winding transformer array."""
+    parsed_branches = []
+    columns = branches.columns
+    for branch in branches:
+        for branch_ in _get_branch3_branches(branch):
+            cyto_elements = {"data": _array_to_dict(branch_, columns)}
+            cyto_elements["data"].update(
+                {
+                    # IDs need to be unique, so we combine the branch ID with the from and to nodes
+                    "id": str(branch.id.item()) + f"_{branch_.from_node.item()}_{branch_.to_node.item()}",
+                    "source": str(branch_.from_node.item()),
+                    "target": str(branch_.to_node.item()),
+                    "group": group,
+                }
+            )
+            parsed_branches.append(cyto_elements)
     return parsed_branches
 
 

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: power-grid-model-ds
-Version: 1.3.3
+Version: 1.4.0
 Summary: Power Grid Model extension which provides a grid data structure for simulation and analysis
 Author-email: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
 License: MPL-2.0

{power_grid_model_ds-1.3.3 → power_grid_model_ds-1.4.0}/src/power_grid_model_ds.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ src/power_grid_model_ds/_core/data_source/generator/arrays/source.py
 src/power_grid_model_ds/_core/data_source/generator/arrays/transformer.py
 src/power_grid_model_ds/_core/model/__init__.py
 src/power_grid_model_ds/_core/model/constants.py
+src/power_grid_model_ds/_core/model/utils.py
 src/power_grid_model_ds/_core/model/arrays/__init__.py
 src/power_grid_model_ds/_core/model/arrays/pgm_arrays.py
 src/power_grid_model_ds/_core/model/arrays/base/__init__.py

power_grid_model_ds-1.3.3/PYPI_VERSION

@@ -1 +0,0 @@
-1.3.3