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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,6 +8,8 @@ from typing import TYPE_CHECKING, Union
8
8
 
9
9
  import numpy as np
10
10
 
11
+ from power_grid_model_ds._core.utils.misc import array_equal_with_nan
12
+
11
13
  if TYPE_CHECKING:
12
14
  from power_grid_model_ds._core.model.arrays.base.array import FancyArray
13
15
 
@@ -44,23 +46,5 @@ def sort(array: "FancyArray", axis=-1, kind=None, order=None) -> "FancyArray":
44
46
  def array_equal(array1: "FancyArray", array2: "FancyArray", equal_nan: bool = True) -> bool:
45
47
  """Return True if two arrays are equal."""
46
48
  if equal_nan:
47
- return _array_equal_with_nan(array1, array2)
49
+ return array_equal_with_nan(array1.data, array2.data)
48
50
  return np.array_equal(array1.data, array2.data)
49
-
50
-
51
- def _array_equal_with_nan(array1: "FancyArray", array2: "FancyArray") -> bool:
52
- # np.array_equal does not work with NaN values in structured arrays, so we need to compare column by column.
53
- # related issue: https://github.com/numpy/numpy/issues/21539
54
-
55
- if array1.columns != array2.columns:
56
- return False
57
-
58
- for column in array1.columns:
59
- column_dtype = array1.dtype[column]
60
- if np.issubdtype(column_dtype, np.str_):
61
- if not np.array_equal(array1[column], array2[column]):
62
- return False
63
- continue
64
- if not np.array_equal(array1[column], array2[column], equal_nan=True):
65
- return False
66
- return True
@@ -25,13 +25,13 @@ def build_array(*args: tuple[Any], dtype: np.dtype, defaults: dict[str, np.gener
25
25
  return array
26
26
 
27
27
  if isinstance(parsed_input, np.ndarray) and parsed_input.dtype.names:
28
- _check_missing_columns(array.dtype.names, defaults, set(parsed_input.dtype.names))
28
+ _check_missing_columns(array.dtype.names or (), defaults, set(parsed_input.dtype.names))
29
29
  return _parse_structured_array(parsed_input, array)
30
30
  if isinstance(parsed_input, np.ndarray):
31
31
  # Note: defaults are not supported when working with unstructured arrays
32
32
  return _parse_array(parsed_input, array.dtype)
33
33
 
34
- _check_missing_columns(array.dtype.names, defaults, set(parsed_input.keys()))
34
+ _check_missing_columns(array.dtype.names or (), defaults, set(parsed_input.keys()))
35
35
  _fill_with_kwargs(array, parsed_input)
36
36
  return array
37
37
 
@@ -54,7 +54,7 @@ def _parse_input(*args: Any, dtype: np.dtype, **kwargs):
54
54
  return {}, 0
55
55
 
56
56
 
57
- def _check_missing_columns(array_columns: tuple, defaults: dict[str, np.generic], provided_columns: set[str]):
57
+ def _check_missing_columns(array_columns: tuple[str, ...], defaults: dict[str, np.generic], provided_columns: set[str]):
58
58
  required_columns = set(array_columns) - set(defaults.keys())
59
59
  if missing_columns := required_columns - provided_columns:
60
60
  raise ValueError(f"Missing required columns: {missing_columns}")
@@ -64,7 +64,8 @@ def _fill_defaults(array: np.ndarray, defaults: dict[str, np.generic]):
64
64
  """Fills the defaults into the array."""
65
65
  for column, default in defaults.items():
66
66
  if default is empty:
67
- array[column] = empty(array.dtype[column]) # type: ignore[call-overload]
67
+ column_type: type = array.dtype[column]
68
+ array[column] = empty(column_type) # type: ignore[call-overload]
68
69
  else:
69
70
  array[column] = default # type: ignore[call-overload]
70
71
 
@@ -87,8 +88,8 @@ def _parse_structured_array(from_array: np.ndarray, to_array: np.ndarray) -> np.
87
88
 
88
89
  def _determine_column_overlap(from_array: np.ndarray, to_array: np.ndarray) -> tuple[list[str], list[str]]:
89
90
  """Returns two lists: columns present in both arrays and the columns that are only present in from_array"""
90
- from_columns = set(from_array.dtype.names)
91
- to_columns = set(to_array.dtype.names)
91
+ from_columns = set(from_array.dtype.names or ())
92
+ to_columns = set(to_array.dtype.names or ())
92
93
 
93
94
  return list(from_columns & to_columns), list(from_columns - to_columns)
94
95
 
@@ -20,7 +20,7 @@ def get_filter_mask(
20
20
  """Returns a mask that matches the input parameters."""
21
21
  parsed_kwargs = _parse(args, kwargs)
22
22
 
23
- if invalid_kwargs := set(parsed_kwargs.keys()) - set(array.dtype.names):
23
+ if invalid_kwargs := set(parsed_kwargs.keys()) - set(array.dtype.names or ()):
24
24
  raise ValueError(f"Invalid kwargs: {invalid_kwargs}")
25
25
 
26
26
  filter_mask = _initialize_filter_mask(mode_, array.size)
@@ -12,7 +12,7 @@ def re_order(array: np.ndarray, new_order: ArrayLike, column: str = "id") -> np.
12
12
  """Re-order an id-array by the id column so that it follows a new_order.
13
13
  Expects the new_order input to contain the same values as self.id
14
14
  """
15
- if column not in array.dtype.names:
15
+ if column not in (array.dtype.names or ()):
16
16
  raise ValueError(f"Cannot re-order array: column {column} does not exist.")
17
17
  if not np.array_equal(np.sort(array[column]), np.sort(new_order)):
18
18
  raise ValueError(f"Cannot re-order array: mismatch between new_order and values in '{column}'-column.")
@@ -50,7 +50,7 @@ def update_by_id(array: np.ndarray, ids: ArrayLike, allow_missing: bool, **kwarg
50
50
 
51
51
  def check_ids(array: np.ndarray, return_duplicates: bool = False) -> NDArray | None:
52
52
  """Check for duplicate ids within the array"""
53
- if "id" not in array.dtype.names:
53
+ if "id" not in (array.dtype.names or ()):
54
54
  raise AttributeError("Array has no 'id' column.")
55
55
 
56
56
  unique, counts = np.unique(array["id"], return_counts=True)
@@ -323,3 +323,11 @@ class FancyArray(ABC):
323
323
  if pandas is None:
324
324
  raise ImportError("pandas is not installed")
325
325
  return pandas.DataFrame(self._data)
326
+
327
+ @classmethod
328
+ def from_extended(cls: Type[Self], extended: Self) -> Self:
329
+ """Create an instance from an extended array."""
330
+ if not isinstance(extended, cls):
331
+ raise TypeError(f"Extended array must be of type {cls.__name__}, got {type(extended).__name__}")
332
+ dtype = cls.get_dtype()
333
+ return cls(data=np.array(extended[list(dtype.names)], dtype=dtype))
@@ -440,6 +440,24 @@ class Grid(FancyArrayContainer):
440
440
  set_is_feeder(grid=self)
441
441
  set_feeder_ids(grid=self)
442
442
 
443
+ @classmethod
444
+ def from_extended(cls, extended: "Grid") -> "Grid":
445
+ """Create a grid from an extended Grid object."""
446
+ new_grid = cls.empty()
447
+
448
+ # Add nodes first, so that branches can reference them
449
+ new_grid.append(new_grid.node.__class__.from_extended(extended.node))
450
+
451
+ for field in dataclasses.fields(cls):
452
+ if field.name == "node":
453
+ continue # already added
454
+ if issubclass(field.type, FancyArray):
455
+ extended_array = getattr(extended, field.name)
456
+ new_array = field.type.from_extended(extended_array)
457
+ new_grid.append(new_array, check_max_id=False)
458
+
459
+ return new_grid
460
+
443
461
 
444
462
  def _add_branch_array(branch: BranchArray | Branch3Array, grid: Grid):
445
463
  """Add a branch array to the grid"""
@@ -39,3 +39,24 @@ def get_inherited_attrs(cls: Type, *private_attributes):
39
39
  retrieved_attributes[private_attr] = attr_dict
40
40
 
41
41
  return retrieved_attributes
42
+
43
+
44
+ def array_equal_with_nan(array1: np.ndarray, array2: np.ndarray) -> bool:
45
+ """Compare two structured arrays for equality, treating NaN values as equal.
46
+
47
+ np.array_equal does not work with NaN values in structured arrays, so we need to compare column by column.
48
+ related issue: https://github.com/numpy/numpy/issues/21539
49
+ """
50
+ if array1.dtype.names != array2.dtype.names:
51
+ return False
52
+
53
+ columns: Sequence[str] = array1.dtype.names
54
+ for column in columns:
55
+ column_dtype = array1.dtype[column]
56
+ if np.issubdtype(column_dtype, np.str_):
57
+ if not np.array_equal(array1[column], array2[column]):
58
+ return False
59
+ continue
60
+ if not np.array_equal(array1[column], array2[column], equal_nan=True):
61
+ return False
62
+ return True
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: power-grid-model-ds
3
- Version: 1.3.2
3
+ Version: 1.3.4
4
4
  Summary: Power Grid Model extension which provides a grid data structure for simulation and analysis
5
5
  Author-email: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
6
6
  License: MPL-2.0
@@ -62,9 +62,7 @@ SPDX-License-Identifier: MPL-2.0
62
62
  [![Downloads](https://static.pepy.tech/badge/power-grid-model-ds)](https://pepy.tech/project/power-grid-model-ds)
63
63
  [![Downloads](https://static.pepy.tech/badge/power-grid-model-ds/month)](https://pepy.tech/project/power-grid-model-ds)
64
64
 
65
- [![Build and Test Python](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/build-test-and-sonar.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/build-test-and-sonar.yml)
66
- [![Check Code Quality](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/check-code-quality.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/check-code-quality.yml)
67
- [![REUSE Compliance Check](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/reuse-compliance.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/reuse-compliance.yml)
65
+ [![CI Build](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/ci.yml/badge.svg)](https://github.com/PowerGridModel/power-grid-model-ds/actions/workflows/ci.yml)
68
66
  [![docs](https://readthedocs.org/projects/power-grid-model-ds/badge/)](https://power-grid-model-ds.readthedocs.io/en/stable/)
69
67
 
70
68
  [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=PowerGridModel_power-grid-model-ds&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=PowerGridModel_power-grid-model-ds)
@@ -78,7 +76,7 @@ SPDX-License-Identifier: MPL-2.0
78
76
 
79
77
  [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14825565.svg)](https://zenodo.org/record/14825565)
80
78
 
81
- [![](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#)
79
+ [![Power Grid Model logo](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#)
82
80
 
83
81
  # Power Grid Model Data Science (DS)
84
82
 
@@ -8,7 +8,7 @@ power_grid_model_ds/generators.py,sha256=suQCHIzLOXjJj3tLn1-vuzR9m6V-bhFZQWEukTp
8
8
  power_grid_model_ds/graph_models.py,sha256=so5niaXJqtuL0hUmtSPxV6Bven5c8DfAlF3MM4I1d28,348
9
9
  power_grid_model_ds/visualizer.py,sha256=W9GfWuM-CrDTnniCj1y-lxSt6IQkLJViW5aPC4syauw,411
10
10
  power_grid_model_ds/_core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
11
- power_grid_model_ds/_core/fancypy.py,sha256=MVnt6gRe2civTQBY17Dtp_wyqARpy4jP1NCpOoNW3nc,2672
11
+ power_grid_model_ds/_core/fancypy.py,sha256=EKH1gIACBPF9lUFI4kUPZJ_peS6B_udsLTs-PysdIns,2065
12
12
  power_grid_model_ds/_core/load_flow.py,sha256=2XKWHwhwvDa6hRgmlrv9XAKIZmTac4BGfpu9cZ1f_to,5832
13
13
  power_grid_model_ds/_core/data_source/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
14
14
  power_grid_model_ds/_core/data_source/generator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -24,12 +24,12 @@ power_grid_model_ds/_core/model/constants.py,sha256=pxkZ-a4J8RVu4ziw_A6usY81I2tt
24
24
  power_grid_model_ds/_core/model/arrays/__init__.py,sha256=WMMIUW5RAkJ6E7tRtu8sImhxjnQDo7h5J2I9dhvfAcw,1013
25
25
  power_grid_model_ds/_core/model/arrays/pgm_arrays.py,sha256=Vmzj6BFVY3vZqfpiOZ0-KDNdi3EbkWv3cUHUx8D29jw,3318
26
26
  power_grid_model_ds/_core/model/arrays/base/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
27
- power_grid_model_ds/_core/model/arrays/base/_build.py,sha256=I7xdpXC5I7wUwi2Gl4m2zMdQ3UeXd1FrP__TafDSUNs,6287
28
- power_grid_model_ds/_core/model/arrays/base/_filters.py,sha256=NqxNP-QK8ltweRT9q-P_BAAHafCzpbBQFuj3XNT0zW0,4235
29
- power_grid_model_ds/_core/model/arrays/base/_modify.py,sha256=zMi5mKk0N7vlvfmtuVBPRE_LOtuRyDyTvKXlk3wJXEA,2460
27
+ power_grid_model_ds/_core/model/arrays/base/_build.py,sha256=NAdmzkjpC4lP-z1y0au8ZDuL7rWSwN-YG2VUv0u5lYM,6365
28
+ power_grid_model_ds/_core/model/arrays/base/_filters.py,sha256=68DBuliTADfp2VNKpuTSq18fgPa5XC4MkxQIH6G9mV8,4241
29
+ power_grid_model_ds/_core/model/arrays/base/_modify.py,sha256=TP8LojFMcZnyzhmshzNQnjlEVSZjE_xJ6BNQ4SpIBvA,2476
30
30
  power_grid_model_ds/_core/model/arrays/base/_optional.py,sha256=zEEaE5z7bjLiARb8WTYsgZhbtJYAT6BTd61IUdv_YTA,288
31
31
  power_grid_model_ds/_core/model/arrays/base/_string.py,sha256=H66DBYq8RHQHj6Gfn2tdEXKoL3ND64iVkZCt-Fwjdn0,3568
32
- power_grid_model_ds/_core/model/arrays/base/array.py,sha256=F2o5Oc2AFfJ_aBpdSzQd5qxhA6-ynE7xuupPDDIPOWg,12758
32
+ power_grid_model_ds/_core/model/arrays/base/array.py,sha256=4PyIoKF4hrKbrBSy6167glg0qI1ZtXheuj11rGZHb8s,13156
33
33
  power_grid_model_ds/_core/model/arrays/base/errors.py,sha256=M62aA2pv9AlSJSvniU1IJTtRC0jvBlMYRxv2SchTdDA,475
34
34
  power_grid_model_ds/_core/model/containers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
35
35
  power_grid_model_ds/_core/model/containers/base.py,sha256=O-GoE2oN-WJl5wKXCl3fUHbvW5qc0oZ2-oY-zUWBGbs,9037
@@ -51,10 +51,10 @@ power_grid_model_ds/_core/model/graphs/models/base.py,sha256=OyhSN4Vn3otM20HDBt0
51
51
  power_grid_model_ds/_core/model/graphs/models/rustworkx.py,sha256=jccM7MUhNqH2215mk_X8ihQ-Q8IkjjRhUk4jSruaxy8,6158
52
52
  power_grid_model_ds/_core/model/grids/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
53
53
  power_grid_model_ds/_core/model/grids/_text_sources.py,sha256=3CWn0zjaUkFhrnSEIqAas52xeW0EX3EWXIXyo8XSQgw,4229
54
- power_grid_model_ds/_core/model/grids/base.py,sha256=8AQdqPuVLBjOKE2JQvlrQErq8NcCowot3SUlJvcmYvA,16592
54
+ power_grid_model_ds/_core/model/grids/base.py,sha256=JzM4pbDr8NwvTIe-lAjGVRGZVYWmM_3BzgWVpIJazKk,17294
55
55
  power_grid_model_ds/_core/model/grids/helpers.py,sha256=lMUEER6l5MfdgLBIesSo_KnqK_K1CyRtu1dj33q924c,4244
56
56
  power_grid_model_ds/_core/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
57
- power_grid_model_ds/_core/utils/misc.py,sha256=aAdlXjyKN6_T4b_CQZ879TbkbDZW4TwBUsxTpkwvymU,1228
57
+ power_grid_model_ds/_core/utils/misc.py,sha256=fPjpczUr3IZ7EnAYI2darLzN2O8NJwhxgnOx7s-vU8w,2044
58
58
  power_grid_model_ds/_core/utils/pickle.py,sha256=LGeTc7nu9RY1noOzLJzYaSHSWIgqzHy2xhmueKGuipc,1445
59
59
  power_grid_model_ds/_core/utils/zip.py,sha256=9RtJYhjlgNZOtxr4iI-CpsjT1axw5kCCqprfTjaIsiI,2197
60
60
  power_grid_model_ds/_core/visualizer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -74,8 +74,8 @@ power_grid_model_ds/_core/visualizer/layout/header.py,sha256=el-5SlWIPeEbZZLbi3v
74
74
  power_grid_model_ds/_core/visualizer/layout/legenda.py,sha256=8JTrMRgaYRaSIXAEoM0b3PgX7AYvW0_fHuYg8nY4y0g,2161
75
75
  power_grid_model_ds/_core/visualizer/layout/search_form.py,sha256=4LPU6MjD3QEIeBEOOWBvV5-GyLMqNYWyKcUa_oWScCs,2002
76
76
  power_grid_model_ds/_core/visualizer/layout/selection_output.py,sha256=fuPAdG5XmTj2E0oQ8w_tp9PGbB8bJ5fguteLtnM1EDg,534
77
- power_grid_model_ds-1.3.2.dist-info/licenses/LICENSE,sha256=GpbnG1pNl-ORtSP6dmHeiZvwy36UFli6MEZy1XlmBqo,14906
78
- power_grid_model_ds-1.3.2.dist-info/METADATA,sha256=drQ-xi6jPybow7UwgXd0_F3LLAP8BTfJqccaUYTrUf8,9353
79
- power_grid_model_ds-1.3.2.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
80
- power_grid_model_ds-1.3.2.dist-info/top_level.txt,sha256=nJa103Eqvm5TESYEKPFVImfLg_ugGOBznikrM-rZQZg,20
81
- power_grid_model_ds-1.3.2.dist-info/RECORD,,
77
+ power_grid_model_ds-1.3.4.dist-info/licenses/LICENSE,sha256=GpbnG1pNl-ORtSP6dmHeiZvwy36UFli6MEZy1XlmBqo,14906
78
+ power_grid_model_ds-1.3.4.dist-info/METADATA,sha256=v75WOuMLCD-YxQdwPTYP3216PeLRyjSvgYV3c9Y38wI,8873
79
+ power_grid_model_ds-1.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
80
+ power_grid_model_ds-1.3.4.dist-info/top_level.txt,sha256=nJa103Eqvm5TESYEKPFVImfLg_ugGOBznikrM-rZQZg,20
81
+ power_grid_model_ds-1.3.4.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.3.1)
2
+ Generator: setuptools (80.9.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5