power-grid-model-ds 1.1.6__py3-none-any.whl → 1.2.1__py3-none-any.whl

power_grid_model_ds/_core/load_flow.py

@@ -43,11 +43,11 @@ class PowerGridModelInterface:
 
     def __init__(
         self,
-        grid: Grid,
+        grid: Optional[Grid] = None,
         input_data: Optional[Dict] = None,
         system_frequency: float = 50.0,
     ):
-        self.grid = grid
+        self.grid = grid or Grid.empty()
         self.system_frequency = system_frequency
 
         self.input_data = input_data or {}
@@ -63,6 +63,26 @@ class PowerGridModelInterface:
             self.input_data[array_name] = pgm_array
         return self.input_data
 
+    def create_grid_from_input_data(self, check_ids: bool = True) -> Grid:
+        """
+        Create Grid object from PowerGridModel input.
+        Note that for some arrays, not all fields are available in the PowerGridModel input.
+        In this case, the default values are used.
+
+        Args:
+            check_ids: if True, check if the ids are unique
+
+        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:
+                pgm_ds_array_class = getattr(self.grid, pgm_name).__class__
+                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()
+        return self.grid
+
     def calculate_power_flow(
         self,
         calculation_method: CalculationMethod = CalculationMethod.newton_raphson,

power_grid_model_ds/_core/model/graphs/container.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 @@ class GraphContainer:
             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 @@ class 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__}")

power_grid_model_ds/_core/model/graphs/models/base.py

@@ -4,13 +4,12 @@
 
 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,
@@ -18,6 +17,9 @@ from power_grid_model_ds._core.model.graphs.errors import (
     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 @@ class BaseGraphModel(ABC):
         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)
 

{power_grid_model_ds-1.1.6.dist-info → power_grid_model_ds-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: power-grid-model-ds
-Version: 1.1.6
+Version: 1.2.1
 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.1.6.dist-info → power_grid_model_ds-1.2.1.dist-info}/RECORD

@@ -8,7 +8,7 @@ power_grid_model_ds/generators.py,sha256=suQCHIzLOXjJj3tLn1-vuzR9m6V-bhFZQWEukTp
 power_grid_model_ds/graph_models.py,sha256=so5niaXJqtuL0hUmtSPxV6Bven5c8DfAlF3MM4I1d28,348
 power_grid_model_ds/_core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/fancypy.py,sha256=MVnt6gRe2civTQBY17Dtp_wyqARpy4jP1NCpOoNW3nc,2672
-power_grid_model_ds/_core/load_flow.py,sha256=qpQkkcTV_-43sg0TwF44gahhWWbg2cqFHdVaecB0GQ0,4959
+power_grid_model_ds/_core/load_flow.py,sha256=TrPg-_Je9s0FE3iLaJ3TQndmomAv7g781k3B9o69nWo,5831
 power_grid_model_ds/_core/data_source/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/data_source/generator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/data_source/generator/grid_generators.py,sha256=knAtQOhdUru3z6Kzc0rjSE9PPeC4_c7SUVVLqTi3ZBU,2972
@@ -32,7 +32,6 @@ power_grid_model_ds/_core/model/arrays/base/array.py,sha256=F2o5Oc2AFfJ_aBpdSzQd
 power_grid_model_ds/_core/model/arrays/base/errors.py,sha256=M62aA2pv9AlSJSvniU1IJTtRC0jvBlMYRxv2SchTdDA,475
 power_grid_model_ds/_core/model/containers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/model/containers/base.py,sha256=O-GoE2oN-WJl5wKXCl3fUHbvW5qc0oZ2-oY-zUWBGbs,9037
-power_grid_model_ds/_core/model/containers/grid_protocol.py,sha256=-t1fSNAO0Gb_tIxnYT2Ehx52xuOUI6oAYqlGTYZXCRA,692
 power_grid_model_ds/_core/model/dtypes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/model/dtypes/appliances.py,sha256=ZfubZm0e7057gv78EQXMeUWefES0icyqFgIgRDnyV5c,1002
 power_grid_model_ds/_core/model/dtypes/branches.py,sha256=Pb65bRmaxCIJf1d2zF1D0r1zIYee1kEifkvgdP8OvTo,3811
@@ -43,11 +42,11 @@ power_grid_model_ds/_core/model/dtypes/sensors.py,sha256=U8HqvyH3fV348m4QjWy8IEY
 power_grid_model_ds/_core/model/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/model/enums/nodes.py,sha256=UuJsWFasKREhVGbsUwGg5A-LvHnGTc4j636A_B4N9A4,356
 power_grid_model_ds/_core/model/graphs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-power_grid_model_ds/_core/model/graphs/container.py,sha256=w3nwfR5sM-EqVPmZWSmhIQ2gcVqSlbqxRVAdrRIMfUc,5813
+power_grid_model_ds/_core/model/graphs/container.py,sha256=9hQLkrUMYnCIFj1gb2aLNXt0XhjGn_tlRv83RmJ9nxE,5830
 power_grid_model_ds/_core/model/graphs/errors.py,sha256=-9fAsCqpKM0-lCM-tO2fVot9hqZBJa8WCxxqWEH_z6k,479
 power_grid_model_ds/_core/model/graphs/models/__init__.py,sha256=xwhMajQKIAfL1R3cq2sMNXMWtqfI5WGBi6-P4clyTes,262
 power_grid_model_ds/_core/model/graphs/models/_rustworkx_search.py,sha256=TqRR22TPx8XjRLukQxK8R8FjZvJ60CttDFctbISSbOM,2979
-power_grid_model_ds/_core/model/graphs/models/base.py,sha256=cHwwQFgPW78P5JDyfGE1fXEfwG7cv9-aG05UKPd_vGo,16710
+power_grid_model_ds/_core/model/graphs/models/base.py,sha256=GJ1ZExVBhpcezzWZqYAOeDSn9ePWvhniGFjR-qL5aBY,16730
 power_grid_model_ds/_core/model/graphs/models/rustworkx.py,sha256=a7PrDgge2KzMbeTQhQTE-KRPdKNj5TJvfYkzYNT8FtM,5730
 power_grid_model_ds/_core/model/grids/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/model/grids/_text_sources.py,sha256=3CWn0zjaUkFhrnSEIqAas52xeW0EX3EWXIXyo8XSQgw,4229
@@ -57,8 +56,8 @@ power_grid_model_ds/_core/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 power_grid_model_ds/_core/utils/misc.py,sha256=aAdlXjyKN6_T4b_CQZ879TbkbDZW4TwBUsxTpkwvymU,1228
 power_grid_model_ds/_core/utils/pickle.py,sha256=LGeTc7nu9RY1noOzLJzYaSHSWIgqzHy2xhmueKGuipc,1445
 power_grid_model_ds/_core/utils/zip.py,sha256=9RtJYhjlgNZOtxr4iI-CpsjT1axw5kCCqprfTjaIsiI,2197
-power_grid_model_ds-1.1.6.dist-info/LICENSE,sha256=GpbnG1pNl-ORtSP6dmHeiZvwy36UFli6MEZy1XlmBqo,14906
-power_grid_model_ds-1.1.6.dist-info/METADATA,sha256=h8kfJZEhqNHRPviLmSYJLAX73fPM7OTF812-u15MjgY,8822
-power_grid_model_ds-1.1.6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-power_grid_model_ds-1.1.6.dist-info/top_level.txt,sha256=nJa103Eqvm5TESYEKPFVImfLg_ugGOBznikrM-rZQZg,20
-power_grid_model_ds-1.1.6.dist-info/RECORD,,
+power_grid_model_ds-1.2.1.dist-info/LICENSE,sha256=GpbnG1pNl-ORtSP6dmHeiZvwy36UFli6MEZy1XlmBqo,14906
+power_grid_model_ds-1.2.1.dist-info/METADATA,sha256=04KhogFPXQ0scaaynKRYeKK2P5MIrG-U7RBV_TnYoFs,8822
+power_grid_model_ds-1.2.1.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+power_grid_model_ds-1.2.1.dist-info/top_level.txt,sha256=nJa103Eqvm5TESYEKPFVImfLg_ugGOBznikrM-rZQZg,20
+power_grid_model_ds-1.2.1.dist-info/RECORD,,

{power_grid_model_ds-1.1.6.dist-info → power_grid_model_ds-1.2.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

power_grid_model_ds/_core/model/containers/grid_protocol.py

@@ -1,22 +0,0 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-"""This file contains the Grid protocol defining the minimal arrays contained in a grid"""
-
-from typing import Protocol
-
-from power_grid_model_ds._core.model.arrays import (
-    BranchArray,
-    NodeArray,
-    ThreeWindingTransformerArray,
-)
-
-
-class MinimalGridArrays(Protocol):
-    """Protocol for the minimal arrays contained in a grid,
-    they may be implemented using properties or added as attributes"""
-
-    node: NodeArray
-    three_winding_transformer: ThreeWindingTransformerArray
-    branches: BranchArray
-    branch_arrays: list[BranchArray]