power-grid-model 1.10.74__py3-none-win_amd64.whl → 1.12.119__py3-none-win_amd64.whl

power_grid_model/enum.py

@@ -1,214 +1,27 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-Common enumerations used by the power-grid-model library.
-
-Note: these enumeration match the C++ arithmetic core, so don't change the values unless you change them in C++ as well
-
-"""
-
-from enum import IntEnum
-
-# Value names are defined in lower case instead of upper case
-# pylint: disable=invalid-name
-
-
-class LoadGenType(IntEnum):
-    """Load and Generator Types"""
-
-    const_power = 0
-    const_impedance = 1
-    const_current = 2
-
-
-class WindingType(IntEnum):
-    """Transformer Winding Types"""
-
-    wye = 0
-    wye_n = 1
-    delta = 2
-    zigzag = 3
-    zigzag_n = 4
-
-
-class BranchSide(IntEnum):
-    """Branch Sides"""
-
-    from_side = 0
-    to_side = 1
-
-
-class Branch3Side(IntEnum):
-    """Branch3 Sides"""
-
-    side_1 = 0
-    side_2 = 1
-    side_3 = 2
-
-
-class CalculationType(IntEnum):
-    """Calculation Types"""
-
-    power_flow = 0
-    state_estimation = 1
-    short_circuit = 2
-
-
-class CalculationMethod(IntEnum):
-    """Calculation Methods"""
-
-    linear = 0
-    newton_raphson = 1
-    iterative_linear = 2
-    iterative_current = 3
-    linear_current = 4
-    iec60909 = 5
-
-
-class TapChangingStrategy(IntEnum):
-    """Tap Changing Strategies"""
-
-    disabled = 0
-    """
-    Disable automatic tap adjustment
-    """
-    any_valid_tap = 1
-    """
-    Adjust tap position automatically; optimize for any value in the voltage band
-    """
-    min_voltage_tap = 2
-    """
-    Adjust tap position automatically; optimize for the lower end of the voltage band
-    """
-    max_voltage_tap = 3
-    """
-    Adjust tap position automatically; optimize for the higher end of the voltage band
-    """
-    fast_any_tap = 4
-    """
-    Adjust tap position automatically; optimize for any value in the voltage band; binary search
-    """
-
-
-class MeasuredTerminalType(IntEnum):
-    """The type of asset measured by a (power) sensor"""
-
-    branch_from = 0
-    """
-    Measuring the from-terminal between a branch (except link) and a node
-    """
-    branch_to = 1
-    """
-    Measuring the to-terminal between a branch (except link) and a node
-    """
-    source = 2
-    """
-    Measuring the terminal between a source and a node
-    """
-    shunt = 3
-    """
-    Measuring the terminal between a shunt and a node
-    """
-    load = 4
-    """
-    Measuring the terminal between a load and a node
-    """
-    generator = 5
-    """
-    Measuring the terminal between a generator and a node
-    """
-    branch3_1 = 6
-    """
-    Measuring the terminal-1 between a branch3 and a node
-    """
-    branch3_2 = 7
-    """
-    Measuring the terminal-2 between a branch3 and a node
-    """
-    branch3_3 = 8
-    """
-    Measuring the terminal-3 between a branch3 and a node
-    """
-    node = 9
-    """
-    Measuring the total power injection into a node
-    """
-
-
-class FaultType(IntEnum):
-    """The type of fault represented by a fault component"""
-
-    three_phase = 0
-    single_phase_to_ground = 1
-    two_phase = 2
-    two_phase_to_ground = 3
-    nan = -128
-    """
-    Unspecified fault type. Needs to be overloaded at the latest in the update_data
-    """
-
-
-class FaultPhase(IntEnum):
-    """The faulty phase(s) affected by the provided fault type"""
-
-    abc = 0
-    """
-    All phases are faulty in a three-phase fault
-    """
-    a = 1
-    """
-    The first phase is faulty in a single-phase-to-ground fault
-    """
-    b = 2
-    """
-    The second phase is faulty in a single-phase-to-ground fault
-    """
-    c = 3
-    """
-    The third phase is faulty in a single-phase-to-ground fault
-    """
-    ab = 4
-    """
-    The first and second phase are faulty in a two-phase or two-phase-to-ground fault
-    """
-    ac = 5
-    """
-    The first and third phase are faulty in a two-phase or two-phase-to-ground fault
-    """
-    bc = 6
-    """
-    The second and third phase are faulty in a two-phase or two-phase-to-ground fault
-    """
-    default_value = -1
-    """
-    Use the default fault phase. Depends on the fault_type.
-    """
-    nan = -128
-    """
-    Unspecified fault phase. Needs to be overloaded at the latest in the update_data
-    """
-
-
-class ShortCircuitVoltageScaling(IntEnum):
-    """Voltage scaling for short circuit calculations"""
-
-    minimum = 0
-    maximum = 1
-
-
-class _ExperimentalFeatures(IntEnum):
-    """Experimental features"""
-
-    disabled = 0
-    enabled = 1
-
-
-class ComponentAttributeFilterOptions(IntEnum):
-    """Filter option component or attribute"""
-
-    everything = 0
-    """Filter all components/attributes"""
-    relevant = 1
-    """Filter only non-empty components/attributes that contain non-NaN values"""
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+Common enumerations used by the power-grid-model library.
+
+Note: these enumeration match the C++ arithmetic core, so don't change the values unless you change them in C++ as well
+
+"""
+
+from power_grid_model._core.enum import (  # noqa: F401
+    AngleMeasurementType,
+    Branch3Side,
+    BranchSide,
+    CalculationMethod,
+    CalculationType,
+    ComponentAttributeFilterOptions,
+    FaultPhase,
+    FaultType,
+    LoadGenType,
+    MeasuredTerminalType,
+    ShortCircuitVoltageScaling,
+    TapChangingStrategy,
+    WindingType,
+    _ExperimentalFeatures,
+)

power_grid_model/errors.py

@@ -1,123 +1,37 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-Error classes used by the power-grid-model library.
-"""
-
-
-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 ConflictID(InvalidID):
-    """Conflicting IDs found."""
-
-
-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 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 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
+
+"""
+Error classes used by the power-grid-model library.
+"""
+
+from power_grid_model._core.errors import (  # noqa: F401
+    AutomaticTapCalculationError,
+    AutomaticTapInputError,
+    ConflictID,
+    ConflictingAngleMeasurementType,
+    ConflictVoltage,
+    IDNotFound,
+    IDWrongType,
+    InvalidArguments,
+    InvalidBranch,
+    InvalidBranch3,
+    InvalidCalculationMethod,
+    InvalidID,
+    InvalidMeasuredObject,
+    InvalidRegulatedObject,
+    InvalidShortCircuitPhaseOrType,
+    InvalidTransformerClock,
+    IterationDiverge,
+    MaxIterationReached,
+    MissingCaseForEnumError,
+    NotObservableError,
+    PowerGridBatchError,
+    PowerGridDatasetError,
+    PowerGridError,
+    PowerGridNotImplementedError,
+    PowerGridSerializationError,
+    PowerGridUnreachableHitError,
+    SparseMatrixError,
+)

power_grid_model/typing.py

@@ -1,48 +1,43 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-Type hints for the power-grid-model library.
-
-This includes all miscellaneous type hints not under dataset or categories.
-"""
-
-from power_grid_model._core.dataset_definitions import (  # pylint: disable=unused-import
-    ComponentType,
-    ComponentTypeVar,
-    DatasetType,
-    DatasetTypeVar,
-)
-from power_grid_model._core.power_grid_meta import (  # pylint: disable=unused-import
-    ComponentMetaData,
-    DatasetMetaData,
-    PowerGridMetaData,
-)
-from power_grid_model.enum import ComponentAttributeFilterOptions
-
-_ComponentAttributeMappingDict = dict[ComponentType, set[str] | list[str] | None | ComponentAttributeFilterOptions]
-
-ComponentAttributeMapping = (
-    set[ComponentTypeVar]
-    | list[ComponentTypeVar]
-    | ComponentAttributeFilterOptions
-    | None
-    | _ComponentAttributeMappingDict
-)
-"""
-Type hint for mapping component attributes.
-
-`ComponentAttributeMapping` can be one of the following:
-
-- A set of :class:`ComponentType` or `str`
-
-- A list of :class:`ComponentType` or `str`
-
-- A :class:`ComponentAttributeFilterOptions <power_grid_model.enum.ComponentAttributeFilterOptions>` value
-
-- `None`
-
-- A dictionary mapping :class:`ComponentType` to a set, list, `None` or
-  :class:`ComponentAttributeFilterOptions <power_grid_model.enum.ComponentAttributeFilterOptions>`
-"""
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+Type hints for the power-grid-model library.
+
+This includes all miscellaneous type hints not under dataset or categories.
+"""
+
+from power_grid_model._core.dataset_definitions import (  # noqa: F401
+    ComponentType,
+    ComponentTypeVar,
+    DatasetType,
+    DatasetTypeVar,
+)
+from power_grid_model._core.power_grid_meta import (  # noqa: F401
+    ComponentMetaData,
+    DatasetMetaData,
+    PowerGridMetaData,
+)
+from power_grid_model._core.typing import (
+    ComponentAttributeMapping as _ComponentAttributeMapping,
+)
+from power_grid_model.enum import ComponentAttributeFilterOptions  # noqa: F401
+
+ComponentAttributeMapping = _ComponentAttributeMapping
+"""
+Type hint for mapping component attributes.
+
+`ComponentAttributeMapping` can be one of the following:
+
+- A set of :class:`ComponentType` or `str`
+
+- A list of :class:`ComponentType` or `str`
+
+- A :class:`ComponentAttributeFilterOptions <power_grid_model.enum.ComponentAttributeFilterOptions>` value
+
+- `None`
+
+- A dictionary mapping :class:`ComponentType` to a set, list, `None` or
+  :class:`ComponentAttributeFilterOptions <power_grid_model.enum.ComponentAttributeFilterOptions>`
+"""