power-grid-model-ds 1.3.4__py3-none-any.whl → 1.4.0__py3-none-any.whl

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/_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/_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/_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/_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/_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.4.dist-info → power_grid_model_ds-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: power-grid-model-ds
-Version: 1.3.4
+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.4.dist-info → power_grid_model_ds-1.4.0.dist-info}/RECORD

@@ -9,7 +9,7 @@ power_grid_model_ds/graph_models.py,sha256=so5niaXJqtuL0hUmtSPxV6Bven5c8DfAlF3MM
 power_grid_model_ds/visualizer.py,sha256=W9GfWuM-CrDTnniCj1y-lxSt6IQkLJViW5aPC4syauw,411
 power_grid_model_ds/_core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/fancypy.py,sha256=EKH1gIACBPF9lUFI4kUPZJ_peS6B_udsLTs-PysdIns,2065
-power_grid_model_ds/_core/load_flow.py,sha256=2XKWHwhwvDa6hRgmlrv9XAKIZmTac4BGfpu9cZ1f_to,5832
+power_grid_model_ds/_core/load_flow.py,sha256=8GYzHw2Uxlzo4pZbjgOXELAP69_0o0yoav4yprZRJ_s,6247
 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
@@ -21,6 +21,7 @@ power_grid_model_ds/_core/data_source/generator/arrays/source.py,sha256=rlrjDI73
 power_grid_model_ds/_core/data_source/generator/arrays/transformer.py,sha256=o2MOhWfitED2YDACLrxSYbeyDf3Rr_4fF0rsW2nROD4,1526
 power_grid_model_ds/_core/model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/model/constants.py,sha256=pxkZ-a4J8RVu4ziw_A6usY81I2tt6sOY1xDBsv6Ta14,746
+power_grid_model_ds/_core/model/utils.py,sha256=j9DDnwTMIbkWTu7HdxGvrRKVZZPaIFtZN212ujsD7p0,786
 power_grid_model_ds/_core/model/arrays/__init__.py,sha256=WMMIUW5RAkJ6E7tRtu8sImhxjnQDo7h5J2I9dhvfAcw,1013
 power_grid_model_ds/_core/model/arrays/pgm_arrays.py,sha256=Vmzj6BFVY3vZqfpiOZ0-KDNdi3EbkWv3cUHUx8D29jw,3318
 power_grid_model_ds/_core/model/arrays/base/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -43,11 +44,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=ZsE6Wr7DvVcYJYjvBszqnHI0QF9cFlHFwTfTAQnWYOA,6602
+power_grid_model_ds/_core/model/graphs/container.py,sha256=M10tTUF_Mn3d2xPmfW2UAf9v5wLzNzCyqokDS5kIbT4,5524
 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=OyhSN4Vn3otM20HDBt0Y6aXeQW7Lis7MuTgGe9aeEgM,17637
+power_grid_model_ds/_core/model/graphs/models/base.py,sha256=LTWn5QROenDxEOu_8d1ehFGg8rj7oCgxsnHX-JoEkEg,16822
 power_grid_model_ds/_core/model/graphs/models/rustworkx.py,sha256=jccM7MUhNqH2215mk_X8ihQ-Q8IkjjRhUk4jSruaxy8,6158
 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
@@ -58,8 +59,8 @@ power_grid_model_ds/_core/utils/misc.py,sha256=fPjpczUr3IZ7EnAYI2darLzN2O8NJwhxg
 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/_core/visualizer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-power_grid_model_ds/_core/visualizer/app.py,sha256=uTtbHCRTQgLnfmJgwRmRSA_2kBHO2PZHD7fn2osGJSE,3340
-power_grid_model_ds/_core/visualizer/parsers.py,sha256=WPotNkHkDNOia6J7YE4F4rWXgKW2TDiBaU3TbolEjLg,2165
+power_grid_model_ds/_core/visualizer/app.py,sha256=dnigMtdGkYquBpFDznLDogTzXR-BHPaa_scdF4GxUlw,3421
+power_grid_model_ds/_core/visualizer/parsers.py,sha256=2QBUkUQD4EsrcJKAY-G0q657ngU41ceMbBBd_0GKJvQ,3246
 power_grid_model_ds/_core/visualizer/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 power_grid_model_ds/_core/visualizer/callbacks/element_scaling.py,sha256=l8PPSqglytqBQgZ4yyNVx3wMYLF8Fcx8ku4skbGNZLM,1136
 power_grid_model_ds/_core/visualizer/callbacks/element_selection.py,sha256=Teaeq0atd2rD_edaW0u_N-YCnaf6MQyC8WsgnEhQczk,963
@@ -74,8 +75,8 @@ power_grid_model_ds/_core/visualizer/layout/header.py,sha256=el-5SlWIPeEbZZLbi3v
 power_grid_model_ds/_core/visualizer/layout/legenda.py,sha256=8JTrMRgaYRaSIXAEoM0b3PgX7AYvW0_fHuYg8nY4y0g,2161
 power_grid_model_ds/_core/visualizer/layout/search_form.py,sha256=4LPU6MjD3QEIeBEOOWBvV5-GyLMqNYWyKcUa_oWScCs,2002
 power_grid_model_ds/_core/visualizer/layout/selection_output.py,sha256=fuPAdG5XmTj2E0oQ8w_tp9PGbB8bJ5fguteLtnM1EDg,534
-power_grid_model_ds-1.3.4.dist-info/licenses/LICENSE,sha256=GpbnG1pNl-ORtSP6dmHeiZvwy36UFli6MEZy1XlmBqo,14906
-power_grid_model_ds-1.3.4.dist-info/METADATA,sha256=v75WOuMLCD-YxQdwPTYP3216PeLRyjSvgYV3c9Y38wI,8873
-power_grid_model_ds-1.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-power_grid_model_ds-1.3.4.dist-info/top_level.txt,sha256=nJa103Eqvm5TESYEKPFVImfLg_ugGOBznikrM-rZQZg,20
-power_grid_model_ds-1.3.4.dist-info/RECORD,,
+power_grid_model_ds-1.4.0.dist-info/licenses/LICENSE,sha256=GpbnG1pNl-ORtSP6dmHeiZvwy36UFli6MEZy1XlmBqo,14906
+power_grid_model_ds-1.4.0.dist-info/METADATA,sha256=yu_d7xuCeaF_aadOmXQss8t5JeCWVeSXDCGVNSPWdSk,8873
+power_grid_model_ds-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+power_grid_model_ds-1.4.0.dist-info/top_level.txt,sha256=nJa103Eqvm5TESYEKPFVImfLg_ugGOBznikrM-rZQZg,20
+power_grid_model_ds-1.4.0.dist-info/RECORD,,