power-grid-model 1.11.33__py3-none-win_amd64.whl → 1.12.70__py3-none-win_amd64.whl

power_grid_model/_core/errors.py

@@ -1,126 +1,130 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-This file contains error classes for library-internal use.
-"""
-
-import numpy as np
-
-
-class PowerGridError(RuntimeError):
-    """Generic power grid error."""
-
-
-class PowerGridBatchError(PowerGridError):
-    """Error occurs in batch calculation."""
-
-    failed_scenarios: np.ndarray
-    succeeded_scenarios: np.ndarray
-    error_messages: list[str]
-    errors: list[PowerGridError]
-
-
-class InvalidArguments(PowerGridError):
-    """A (combination of) input arguments is not valid."""
-
-
-class MissingCaseForEnumError(InvalidArguments):
-    """An enum value is not covered in a for loop.
-
-    This usually happens when an invalid combination of (enum) settings is provided."""
-
-
-class ConflictVoltage(PowerGridError):
-    """There is a confliciting voltage"""
-
-
-class InvalidBranch(PowerGridError):
-    """A branch is invalid."""
-
-
-class InvalidBranch3(PowerGridError):
-    """A branch3 is invalid."""
-
-
-class InvalidTransformerClock(PowerGridError):
-    """Invalid transformer clock found."""
-
-
-class SparseMatrixError(PowerGridError):
-    """Attempting to invert a non-invertible matrix."""
-
-
-class NotObservableError(SparseMatrixError):
-    """Attempting to solve a non-observable system."""
-
-
-class IterationDiverge(PowerGridError):
-    """Unable to iteratively converge to an optimum within the set number of iterations and precision."""
-
-
-class MaxIterationReached(IterationDiverge):
-    """Maximum number of iterations reached."""
-
-
-class InvalidID(PowerGridError):
-    """An ID is invalid."""
-
-
-class IDNotFound(InvalidID):
-    """A reference to a non-existent ID was provided."""
-
-
-class InvalidMeasuredObject(InvalidID):
-    """A provided measured object is invalid."""
-
-
-class InvalidRegulatedObject(InvalidID):
-    """A provided regulated object is invalid."""
-
-
-class IDWrongType(InvalidID):
-    """A referenced ID points to a component that cannot be referenced here."""
-
-
-class ConflictID(InvalidID):
-    """Conflicting IDs found."""
-
-
-class InvalidCalculationMethod(PowerGridError):
-    """Invalid calculation method provided."""
-
-
-class AutomaticTapCalculationError(PowerGridError):
-    """Automatic tap changer with tap at LV side is unsupported for automatic tap changing calculation."""
-
-
-class AutomaticTapInputError(PowerGridError):
-    """Automatic tap changer has invalid configuration."""
-
-
-class ConflictingAngleMeasurementType(PowerGridError):
-    """Conflicting angle measurement types found."""
-
-
-class InvalidShortCircuitPhaseOrType(PowerGridError):
-    """Invalid (combination of) short circuit types and phase(s) provided."""
-
-
-class PowerGridSerializationError(PowerGridError):
-    """Error occurs during (de-)serialization."""
-
-
-class PowerGridDatasetError(PowerGridError):
-    """Error occurs during dataset handling."""
-
-
-class PowerGridNotImplementedError(PowerGridError):
-    """The functionality is either not supported or not yet implemented."""
-
-
-class PowerGridUnreachableHitError(PowerGridError):
-    """Supposedly unreachable code was hit.
-
-    This usually means a failed assumption and may be caused by a bug in the PGM library."""
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+This file contains error classes for library-internal use.
+"""
+
+import numpy as np
+
+
+class PowerGridError(RuntimeError):
+    """Generic power grid error."""
+
+
+class PowerGridBatchError(PowerGridError):
+    """Error occurs in batch calculation."""
+
+    failed_scenarios: np.ndarray
+    succeeded_scenarios: np.ndarray
+    error_messages: list[str]
+    errors: list[PowerGridError]
+
+
+class InvalidArguments(PowerGridError):
+    """A (combination of) input arguments is not valid."""
+
+
+class MissingCaseForEnumError(InvalidArguments):
+    """An enum value is not covered in a for loop.
+
+    This usually happens when an invalid combination of (enum) settings is provided."""
+
+
+class ConflictVoltage(PowerGridError):
+    """There is a confliciting voltage"""
+
+
+class InvalidBranch(PowerGridError):
+    """A branch is invalid."""
+
+
+class InvalidBranch3(PowerGridError):
+    """A branch3 is invalid."""
+
+
+class InvalidTransformerClock(PowerGridError):
+    """Invalid transformer clock found."""
+
+
+class SparseMatrixError(PowerGridError):
+    """Attempting to invert a non-invertible matrix."""
+
+
+class NotObservableError(SparseMatrixError):
+    """Attempting to solve a non-observable system."""
+
+
+class IterationDiverge(PowerGridError):
+    """Unable to iteratively converge to an optimum within the set number of iterations and precision."""
+
+
+class MaxIterationReached(IterationDiverge):
+    """Maximum number of iterations reached."""
+
+
+class InvalidID(PowerGridError):
+    """An ID is invalid."""
+
+
+class IDNotFound(InvalidID):
+    """A reference to a non-existent ID was provided."""
+
+
+class InvalidMeasuredObject(InvalidID):
+    """A provided measured object is invalid."""
+
+
+class InvalidRegulatedObject(InvalidID):
+    """A provided regulated object is invalid."""
+
+
+class IDWrongType(InvalidID):
+    """A referenced ID points to a component that cannot be referenced here."""
+
+
+class ConflictID(InvalidID):
+    """Conflicting IDs found."""
+
+
+class InvalidCalculationMethod(PowerGridError):
+    """Invalid calculation method provided."""
+
+
+class AutomaticTapCalculationError(PowerGridError):
+    """Automatic tap changer with tap at LV side is unsupported for automatic tap changing calculation."""
+
+
+class AutomaticTapInputError(PowerGridError):
+    """Automatic tap changer has invalid configuration."""
+
+
+class ConflictingAngleMeasurementType(PowerGridError):
+    """Conflicting angle measurement types found."""
+
+
+class InvalidShortCircuitPhaseOrType(PowerGridError):
+    """Invalid (combination of) short circuit types and phase(s) provided."""
+
+
+class TapSearchStrategyIncompatibleError(InvalidArguments):
+    """Search method is incompatible with optimization strategy."""
+
+
+class PowerGridSerializationError(PowerGridError):
+    """Error occurs during (de-)serialization."""
+
+
+class PowerGridDatasetError(PowerGridError):
+    """Error occurs during dataset handling."""
+
+
+class PowerGridNotImplementedError(PowerGridError):
+    """The functionality is either not supported or not yet implemented."""
+
+
+class PowerGridUnreachableHitError(PowerGridError):
+    """Supposedly unreachable code was hit.
+
+    This usually means a failed assumption and may be caused by a bug in the PGM library."""

power_grid_model/_core/index_integer.py

@@ -1,17 +1,17 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-Definition of integers used by the calculation core
-"""
-
-# define internal index integer
-from ctypes import c_int32, c_int64
-
-import numpy as np
-
-IdxC = c_int64
-IdxNp = np.int64
-IdC = c_int32
-IdNp = np.int32
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+Definition of integers used by the calculation core
+"""
+
+# define internal index integer
+from ctypes import c_int32, c_int64
+
+import numpy as np
+
+IdxC = c_int64
+IdxNp = np.int64
+IdC = c_int32
+IdNp = np.int32

power_grid_model/_core/options.py

@@ -1,70 +1,71 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-Option class
-"""
-
-from typing import Any, Callable
-
-from power_grid_model._core.power_grid_core import OptionsPtr, power_grid_core as pgc
-
-
-class OptionSetter:
-    """
-    setter for options
-    """
-
-    _setter: Callable
-
-    def __init__(self, setter):
-        self._setter = setter
-
-    def __set__(self, instance: "Options", value: Any):
-        self._setter(instance.opt, value)
-
-    def __get__(self, instance, owner):
-        raise NotImplementedError("Cannot get option value!")
-
-
-class Options:
-    """
-    Option class
-    """
-
-    _opt: OptionsPtr
-    # option setter
-    calculation_type = OptionSetter(pgc.set_calculation_type)
-    calculation_method = OptionSetter(pgc.set_calculation_method)
-    symmetric = OptionSetter(pgc.set_symmetric)
-    error_tolerance = OptionSetter(pgc.set_err_tol)
-    max_iterations = OptionSetter(pgc.set_max_iter)
-    threading = OptionSetter(pgc.set_threading)
-    tap_changing_strategy = OptionSetter(pgc.set_tap_changing_strategy)
-    short_circuit_voltage_scaling = OptionSetter(pgc.set_short_circuit_voltage_scaling)
-    experimental_features = OptionSetter(pgc.set_experimental_features)
-
-    @property
-    def opt(self) -> OptionsPtr:
-        """
-
-        Returns: Pointer to the option object
-
-        """
-        return self._opt
-
-    def __new__(cls, *args, **kwargs):
-        instance = super().__new__(cls, *args, **kwargs)
-        instance._opt = pgc.create_options()
-        return instance
-
-    def __del__(self):
-        pgc.destroy_options(self._opt)
-
-    # not copyable
-    def __copy__(self):
-        raise NotImplementedError("Class not copyable")
-
-    def __deepcopy__(self, memodict):
-        raise NotImplementedError("class not copyable")
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+Option class
+"""
+
+from collections.abc import Callable
+from typing import Any
+
+from power_grid_model._core.power_grid_core import OptionsPtr, power_grid_core as pgc
+
+
+class OptionSetter:
+    """
+    setter for options
+    """
+
+    _setter: Callable
+
+    def __init__(self, setter):
+        self._setter = setter
+
+    def __set__(self, instance: "Options", value: Any):
+        self._setter(instance.opt, value)
+
+    def __get__(self, instance, owner):
+        raise NotImplementedError("Cannot get option value!")
+
+
+class Options:
+    """
+    Option class
+    """
+
+    _opt: OptionsPtr
+    # option setter
+    calculation_type = OptionSetter(pgc.set_calculation_type)
+    calculation_method = OptionSetter(pgc.set_calculation_method)
+    symmetric = OptionSetter(pgc.set_symmetric)
+    error_tolerance = OptionSetter(pgc.set_err_tol)
+    max_iterations = OptionSetter(pgc.set_max_iter)
+    threading = OptionSetter(pgc.set_threading)
+    tap_changing_strategy = OptionSetter(pgc.set_tap_changing_strategy)
+    short_circuit_voltage_scaling = OptionSetter(pgc.set_short_circuit_voltage_scaling)
+    experimental_features = OptionSetter(pgc.set_experimental_features)
+
+    @property
+    def opt(self) -> OptionsPtr:
+        """
+
+        Returns: Pointer to the option object
+
+        """
+        return self._opt
+
+    def __new__(cls, *args, **kwargs):
+        instance = super().__new__(cls, *args, **kwargs)
+        instance._opt = pgc.create_options()
+        return instance
+
+    def __del__(self):
+        pgc.destroy_options(self._opt)
+
+    # not copyable
+    def __copy__(self):
+        raise NotImplementedError("Class not copyable")
+
+    def __deepcopy__(self, memodict):
+        raise NotImplementedError("class not copyable")