power-grid-model 1.10.105__py3-none-win_amd64.whl → 1.12.72__py3-none-win_amd64.whl

power_grid_model/_core/dataset_definitions.py

@@ -1,112 +1,109 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""Data types for power grid model dataset and component types."""
-
-# This file is automatically generated. DO NOT modify it manually!
-
-from enum import Enum, EnumMeta
-from typing import Any, Mapping, TypeAlias, TypeVar
-
-# fmt: off
-
-# pylint: disable=invalid-name
-
-class _MetaEnum(EnumMeta):
-    def __contains__(cls, member):
-        """
-        Check if member is part of the Enum.
-
-        Args:
-            member: Member to check.
-
-        Returns:
-            bool: True if the member is part of the Enum, False otherwise.
-        """
-        return member in cls.__members__.keys()
-
-
-class DatasetType(str, Enum, metaclass=_MetaEnum):
-    """
-    A DatasetType is the type of a :class:`Dataset` in power grid model.
-
-    - Examples:
-
-        - DatasetType.input = "input"
-        - DatasetType.update = "update"
-    """
-
-    input = "input"
-    sym_output = "sym_output"
-    asym_output = "asym_output"
-    update = "update"
-    sc_output = "sc_output"
-
-
-class ComponentType(str, Enum, metaclass=_MetaEnum):
-    """
-    A ComponentType is the type of a grid component.
-
-    - Examples:
-
-        - ComponentType.node = "node"
-        - ComponentType.line = "line"
-    """
-
-    node = "node"
-    line = "line"
-    asym_line = "asym_line"
-    link = "link"
-    generic_branch = "generic_branch"
-    transformer = "transformer"
-    transformer_tap_regulator = "transformer_tap_regulator"
-    three_winding_transformer = "three_winding_transformer"
-    sym_load = "sym_load"
-    sym_gen = "sym_gen"
-    asym_load = "asym_load"
-    asym_gen = "asym_gen"
-    shunt = "shunt"
-    source = "source"
-    sym_voltage_sensor = "sym_voltage_sensor"
-    asym_voltage_sensor = "asym_voltage_sensor"
-    sym_power_sensor = "sym_power_sensor"
-    asym_power_sensor = "asym_power_sensor"
-    sym_current_sensor = "sym_current_sensor"
-    asym_current_sensor = "asym_current_sensor"
-    fault = "fault"
-
-
-# pylint: enable=invalid-name
-
-DatasetTypeLike: TypeAlias = DatasetType | str
-DatasetTypeVar = TypeVar("DatasetTypeVar", bound=DatasetTypeLike)  # helper used for type deduction
-
-ComponentTypeLike: TypeAlias = ComponentType | str
-ComponentTypeVar = TypeVar("ComponentTypeVar", bound=ComponentTypeLike)  # helper used for type deduction
-
-
-def _str_to_datatype(data_type: DatasetTypeLike) -> DatasetType:
-    """Helper function to transform data_type str to DatasetType."""
-    if isinstance(data_type, DatasetType):
-        return data_type
-    return DatasetType[data_type]
-
-
-def _map_to_datatypes(data: Mapping[DatasetTypeVar, Any]) -> dict[DatasetType, Any]:
-    """Helper function to map datatype str keys to DatasetType."""
-    return {_str_to_datatype(key): value for key, value in data.items()}
-
-
-def _str_to_component_type(component: ComponentTypeLike) -> ComponentType:
-    """Helper function to transform component str to ComponentType."""
-    if isinstance(component, ComponentType):
-        return component
-    return ComponentType[component]
-
-
-def _map_to_component_types(data: Mapping[ComponentTypeVar, Any]) -> dict[ComponentType, Any]:
-    """Helper function to map componenttype str keys to ComponentType."""
-    return {_str_to_component_type(key): value for key, value in data.items()}
-
-# fmt: on
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""Data types for power grid model dataset and component types."""
+
+# This file is automatically generated. DO NOT modify it manually!
+
+from collections.abc import Mapping
+from enum import Enum, EnumMeta
+from typing import Any, TypeAlias, TypeVar
+
+# fmt: off
+
+class _MetaEnum(EnumMeta):
+    def __contains__(cls, member):
+        """
+        Check if member is part of the Enum.
+
+        Args:
+            member: Member to check.
+
+        Returns:
+            bool: True if the member is part of the Enum, False otherwise.
+        """
+        return member in cls.__members__
+
+
+class DatasetType(str, Enum, metaclass=_MetaEnum):
+    """
+    A DatasetType is the type of a :class:`Dataset` in power grid model.
+
+    - Examples:
+
+        - DatasetType.input = "input"
+        - DatasetType.update = "update"
+    """
+
+    input = "input"
+    sym_output = "sym_output"
+    asym_output = "asym_output"
+    update = "update"
+    sc_output = "sc_output"
+
+
+class ComponentType(str, Enum, metaclass=_MetaEnum):
+    """
+    A ComponentType is the type of a grid component.
+
+    - Examples:
+
+        - ComponentType.node = "node"
+        - ComponentType.line = "line"
+    """
+
+    node = "node"
+    line = "line"
+    asym_line = "asym_line"
+    link = "link"
+    generic_branch = "generic_branch"
+    transformer = "transformer"
+    transformer_tap_regulator = "transformer_tap_regulator"
+    three_winding_transformer = "three_winding_transformer"
+    sym_load = "sym_load"
+    sym_gen = "sym_gen"
+    asym_load = "asym_load"
+    asym_gen = "asym_gen"
+    shunt = "shunt"
+    source = "source"
+    sym_voltage_sensor = "sym_voltage_sensor"
+    asym_voltage_sensor = "asym_voltage_sensor"
+    sym_power_sensor = "sym_power_sensor"
+    asym_power_sensor = "asym_power_sensor"
+    sym_current_sensor = "sym_current_sensor"
+    asym_current_sensor = "asym_current_sensor"
+    fault = "fault"
+
+
+DatasetTypeLike: TypeAlias = DatasetType | str
+DatasetTypeVar = TypeVar("DatasetTypeVar", bound=DatasetTypeLike)  # helper used for type deduction
+
+ComponentTypeLike: TypeAlias = ComponentType | str
+ComponentTypeVar = TypeVar("ComponentTypeVar", bound=ComponentTypeLike)  # helper used for type deduction
+
+
+def _str_to_datatype(data_type: DatasetTypeLike) -> DatasetType:
+    """Helper function to transform data_type str to DatasetType."""
+    if isinstance(data_type, DatasetType):
+        return data_type
+    return DatasetType[data_type]
+
+
+def _map_to_datatypes(data: Mapping[DatasetTypeVar, Any]) -> dict[DatasetType, Any]:
+    """Helper function to map datatype str keys to DatasetType."""
+    return {_str_to_datatype(key): value for key, value in data.items()}
+
+
+def _str_to_component_type(component: ComponentTypeLike) -> ComponentType:
+    """Helper function to transform component str to ComponentType."""
+    if isinstance(component, ComponentType):
+        return component
+    return ComponentType[component]
+
+
+def _map_to_component_types(data: Mapping[ComponentTypeVar, Any]) -> dict[ComponentType, Any]:
+    """Helper function to map componenttype str keys to ComponentType."""
+    return {_str_to_component_type(key): value for key, value in data.items()}
+
+# fmt: on

power_grid_model/_core/enum.py

@@ -0,0 +1,226 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+Common enumerations for library-internal use.
+
+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
+
+
+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 AngleMeasurementType(IntEnum):
+    """The type of the angle measurement for current sensors."""
+
+    local_angle = 0
+    """
+    The angle is relative to the local voltage angle
+    """
+    global_angle = 1
+    """
+    The angle is relative to the global voltage angle.
+    """
+
+
+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"""
+
+
+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 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
+    """