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

power_grid_model/_core/power_grid_model.py

@@ -1,686 +1,969 @@
-# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-#
-# SPDX-License-Identifier: MPL-2.0
-
-"""
-Main power grid model class
-"""
-
-from enum import IntEnum
-
-import numpy as np
-
-from power_grid_model._core.data_handling import (
-    create_output_data,
-    get_output_type,
-    prepare_input_view,
-    prepare_output_view,
-    prepare_update_view,
-)
-from power_grid_model._core.data_types import Dataset, SingleDataset
-from power_grid_model._core.dataset_definitions import (
-    ComponentType,
-    ComponentTypeLike,
-    _map_to_component_types,
-    _str_to_component_type,
-)
-from power_grid_model._core.enum import (
-    CalculationMethod,
-    CalculationType,
-    ShortCircuitVoltageScaling,
-    TapChangingStrategy,
-    _ExperimentalFeatures,
-)
-from power_grid_model._core.error_handling import PowerGridBatchError, assert_no_error, handle_errors
-from power_grid_model._core.index_integer import IdNp, IdxNp
-from power_grid_model._core.options import Options
-from power_grid_model._core.power_grid_core import ConstDatasetPtr, IDPtr, IdxPtr, ModelPtr, power_grid_core as pgc
-from power_grid_model._core.typing import ComponentAttributeMapping
-
-
-class PowerGridModel:
-    """
-    Main class for Power Grid Model
-    """
-
-    _model_ptr: ModelPtr
-    _all_component_count: dict[ComponentType, int] | None
-    _batch_error: PowerGridBatchError | None
-
-    @property
-    def batch_error(self) -> PowerGridBatchError | None:
-        """
-        Get the batch error object, if present, after a batch calculation with errors.
-
-        Also works when continue_on_batch_error was set to True during the calculation.
-
-        Returns:
-            Batch error object, or None
-        """
-        return self._batch_error
-
-    @property
-    def _model(self):
-        if not self._model_ptr:
-            raise TypeError("You have an empty instance of PowerGridModel!")
-        return self._model_ptr
-
-    @property
-    def all_component_count(self) -> dict[ComponentType, int]:
-        """
-        Get amount of elements per component type.
-        If the count for a component type is zero, it will not be in the returned dictionary.
-
-        Returns:
-            A dictionary with
-
-                - key: Component type name
-                - value: Integer count of elements of this type
-        """
-        if self._all_component_count is None:
-            raise TypeError("You have an empty instance of PowerGridModel!")
-        return self._all_component_count
-
-    def copy(self) -> "PowerGridModel":
-        """
-        Copy the current model
-
-        Returns:
-            A copy of PowerGridModel
-        """
-        new_model = PowerGridModel.__new__(PowerGridModel)
-        new_model._model_ptr = pgc.copy_model(self._model)
-        assert_no_error()
-        new_model._all_component_count = self._all_component_count
-        return new_model
-
-    def __copy__(self):
-        return self.copy()
-
-    def __new__(cls, *_args, **_kwargs):
-        instance = super().__new__(cls)
-        instance._model_ptr = ModelPtr()
-        instance._all_component_count = None
-        return instance
-
-    def __init__(self, input_data: SingleDataset, system_frequency: float = 50.0):
-        """
-        Initialize the model from an input data set.
-
-        Args:
-            input_data: Input data dictionary
-
-                - key: Component type
-                - value: Component data with the correct type :class:`SingleComponentData`
-
-            system_frequency: Frequency of the power system, default 50 Hz
-        """
-        # destroy old instance
-        pgc.destroy_model(self._model_ptr)
-        self._all_component_count = None
-        # create new
-        prepared_input = prepare_input_view(_map_to_component_types(input_data))
-        self._model_ptr = pgc.create_model(system_frequency, input_data=prepared_input.get_dataset_ptr())
-        assert_no_error()
-        self._all_component_count = {k: v for k, v in prepared_input.get_info().total_elements().items() if v > 0}
-
-    def update(self, *, update_data: Dataset):
-        """
-        Update the model with changes.
-
-        The model will be in an invalid state if the update fails and should be discarded.
-
-        Args:
-            update_data: Update data dictionary
-
-                - key: Component type
-                - value: Component data with the correct type :class:`ComponentData` (single scenario or batch)
-
-        Raises:
-            PowerGridError if the update fails. The model is left in an invalid state and should be discarded.
-
-        Returns:
-            None
-        """
-        prepared_update = prepare_update_view(_map_to_component_types(update_data))
-        pgc.update_model(self._model, prepared_update.get_dataset_ptr())
-        assert_no_error()
-
-    def get_indexer(self, component_type: ComponentTypeLike, ids: np.ndarray):
-        """
-        Get array of indexers given array of ids for component type.
-
-        This enables syntax like input_data[ComponentType.node][get_indexer(ids)]
-
-        Args:
-            component_type: Type of component
-            ids: Array of ids
-
-        Returns:
-            Array of indexers, same shape as input array ids
-        """
-        component_type = _str_to_component_type(component_type)
-        ids_c = np.ascontiguousarray(ids, dtype=IdNp).ctypes.data_as(IDPtr)
-        indexer = np.empty_like(ids, dtype=IdxNp, order="C")
-        indexer_c = indexer.ctypes.data_as(IdxPtr)
-        size = ids.size
-        # call c function
-        pgc.get_indexer(self._model, component_type, size, ids_c, indexer_c)
-        assert_no_error()
-        return indexer
-
-    def _get_output_component_count(self, calculation_type: CalculationType):
-        exclude_types = {
-            CalculationType.power_flow: [
-                ComponentType.sym_voltage_sensor,
-                ComponentType.asym_voltage_sensor,
-                ComponentType.sym_power_sensor,
-                ComponentType.asym_power_sensor,
-                ComponentType.fault,
-            ],
-            CalculationType.state_estimation: [ComponentType.fault],
-            CalculationType.short_circuit: [
-                ComponentType.sym_voltage_sensor,
-                ComponentType.asym_voltage_sensor,
-                ComponentType.sym_power_sensor,
-                ComponentType.asym_power_sensor,
-            ],
-        }.get(calculation_type, [])
-
-        def include_type(component_type: ComponentType):
-            return all(exclude_type.value not in component_type.value for exclude_type in exclude_types)
-
-        return {ComponentType[k]: v for k, v in self.all_component_count.items() if include_type(k)}
-
-    def _construct_output(
-        self,
-        output_component_types: ComponentAttributeMapping,
-        calculation_type: CalculationType,
-        symmetric: bool,
-        is_batch: bool,
-        batch_size: int,
-    ) -> dict[ComponentType, np.ndarray]:
-        all_component_count = self._get_output_component_count(calculation_type=calculation_type)
-        return create_output_data(
-            output_component_types=output_component_types,
-            output_type=get_output_type(calculation_type=calculation_type, symmetric=symmetric),
-            all_component_count=all_component_count,
-            is_batch=is_batch,
-            batch_size=batch_size,
-        )
-
-    @staticmethod
-    def _options(**kwargs) -> Options:
-        def as_enum_value(key_enum: str, type_: type[IntEnum]):
-            if key_enum in kwargs:
-                value_enum = kwargs[key_enum]
-                if isinstance(value_enum, str):
-                    kwargs[key_enum] = type_[value_enum]
-
-        as_enum_value("calculation_method", CalculationMethod)
-        as_enum_value("tap_changing_strategy", TapChangingStrategy)
-        as_enum_value("short_circuit_voltage_scaling", ShortCircuitVoltageScaling)
-        as_enum_value("experimental_features", _ExperimentalFeatures)
-
-        opt = Options()
-        for key, value in kwargs.items():
-            setattr(opt, key, value.value if isinstance(value, IntEnum) else value)
-        return opt
-
-    def _handle_errors(self, continue_on_batch_error: bool, batch_size: int, decode_error: bool):
-        self._batch_error = handle_errors(
-            continue_on_batch_error=continue_on_batch_error,
-            batch_size=batch_size,
-            decode_error=decode_error,
-        )
-
-    def _calculate_impl(  # noqa: PLR0913
-        self,
-        calculation_type: CalculationType,
-        symmetric: bool,
-        update_data: Dataset | None,
-        output_component_types: ComponentAttributeMapping,
-        options: Options,
-        continue_on_batch_error: bool,
-        decode_error: bool,
-        experimental_features: _ExperimentalFeatures | str,  # NOSONAR # noqa: ARG002
-    ):
-        """
-        Core calculation routine
-
-        Args:
-            calculation_type:
-            symmetric:
-            update_data:
-            output_component_types:
-            options:
-            continue_on_batch_error:
-            decode_error:
-
-        Returns:
-        """
-        self._batch_error = None
-        is_batch = update_data is not None
-
-        if update_data is not None:
-            prepared_update = prepare_update_view(update_data)
-            update_ptr = prepared_update.get_dataset_ptr()
-            batch_size = prepared_update.get_info().batch_size()
-        else:
-            update_ptr = ConstDatasetPtr()
-            batch_size = 1
-
-        output_data = self._construct_output(
-            output_component_types=output_component_types,
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            is_batch=is_batch,
-            batch_size=batch_size,
-        )
-        prepared_result = prepare_output_view(
-            output_data=output_data,
-            output_type=get_output_type(calculation_type=calculation_type, symmetric=symmetric),
-        )
-
-        # run calculation
-        pgc.calculate(
-            # model and options
-            self._model,
-            options.opt,
-            output_data=prepared_result.get_dataset_ptr(),
-            update_data=update_ptr,
-        )
-
-        self._handle_errors(
-            continue_on_batch_error=continue_on_batch_error,
-            batch_size=batch_size,
-            decode_error=decode_error,
-        )
-
-        return output_data
-
-    def _calculate_power_flow(  # noqa: PLR0913
-        self,
-        *,
-        symmetric: bool = True,
-        error_tolerance: float = 1e-8,
-        max_iterations: int = 20,
-        calculation_method: CalculationMethod | str = CalculationMethod.newton_raphson,
-        update_data: Dataset | None = None,
-        threading: int = -1,
-        output_component_types: ComponentAttributeMapping = None,
-        continue_on_batch_error: bool = False,
-        decode_error: bool = True,
-        tap_changing_strategy: TapChangingStrategy | str = TapChangingStrategy.disabled,
-        experimental_features: _ExperimentalFeatures | str = _ExperimentalFeatures.disabled,
-    ):
-        calculation_type = CalculationType.power_flow
-        options = self._options(
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            error_tolerance=error_tolerance,
-            max_iterations=max_iterations,
-            calculation_method=calculation_method,
-            tap_changing_strategy=tap_changing_strategy,
-            threading=threading,
-            experimental_features=experimental_features,
-        )
-        return self._calculate_impl(
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            update_data=update_data,
-            output_component_types=output_component_types,
-            options=options,
-            continue_on_batch_error=continue_on_batch_error,
-            decode_error=decode_error,
-            experimental_features=experimental_features,
-        )
-
-    def _calculate_state_estimation(  # noqa: PLR0913
-        self,
-        *,
-        symmetric: bool = True,
-        error_tolerance: float = 1e-8,
-        max_iterations: int = 20,
-        calculation_method: CalculationMethod | str = CalculationMethod.iterative_linear,
-        update_data: Dataset | None = None,
-        threading: int = -1,
-        output_component_types: ComponentAttributeMapping = None,
-        continue_on_batch_error: bool = False,
-        decode_error: bool = True,
-        experimental_features: _ExperimentalFeatures | str = _ExperimentalFeatures.disabled,
-    ) -> dict[ComponentType, np.ndarray]:
-        calculation_type = CalculationType.state_estimation
-        options = self._options(
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            error_tolerance=error_tolerance,
-            max_iterations=max_iterations,
-            calculation_method=calculation_method,
-            threading=threading,
-            experimental_features=experimental_features,
-        )
-        return self._calculate_impl(
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            update_data=update_data,
-            output_component_types=output_component_types,
-            options=options,
-            continue_on_batch_error=continue_on_batch_error,
-            decode_error=decode_error,
-            experimental_features=experimental_features,
-        )
-
-    def _calculate_short_circuit(  # noqa: PLR0913
-        self,
-        *,
-        calculation_method: CalculationMethod | str = CalculationMethod.iec60909,
-        update_data: Dataset | None = None,
-        threading: int = -1,
-        output_component_types: ComponentAttributeMapping = None,
-        continue_on_batch_error: bool = False,
-        decode_error: bool = True,
-        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str = ShortCircuitVoltageScaling.maximum,
-        experimental_features: _ExperimentalFeatures | str = _ExperimentalFeatures.disabled,
-    ) -> dict[ComponentType, np.ndarray]:
-        calculation_type = CalculationType.short_circuit
-        symmetric = False
-
-        options = self._options(
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            calculation_method=calculation_method,
-            threading=threading,
-            short_circuit_voltage_scaling=short_circuit_voltage_scaling,
-            experimental_features=experimental_features,
-        )
-        return self._calculate_impl(
-            calculation_type=calculation_type,
-            symmetric=symmetric,
-            update_data=update_data,
-            output_component_types=output_component_types,
-            options=options,
-            continue_on_batch_error=continue_on_batch_error,
-            decode_error=decode_error,
-            experimental_features=experimental_features,
-        )
-
-    def calculate_power_flow(  # noqa: PLR0913
-        self,
-        *,
-        symmetric: bool = True,
-        error_tolerance: float = 1e-8,
-        max_iterations: int = 20,
-        calculation_method: CalculationMethod | str = CalculationMethod.newton_raphson,
-        update_data: dict[str, np.ndarray | dict[str, np.ndarray]] | Dataset | None = None,
-        threading: int = -1,
-        output_component_types: ComponentAttributeMapping = None,
-        continue_on_batch_error: bool = False,
-        decode_error: bool = True,
-        tap_changing_strategy: TapChangingStrategy | str = TapChangingStrategy.disabled,
-    ) -> dict[ComponentType, np.ndarray]:
-        """
-        Calculate power flow once with the current model attributes.
-        Or calculate in batch with the given update dataset in batch.
-
-        Args:
-            symmetric (bool, optional): Whether to perform a three-phase symmetric calculation.
-
-                - True: Three-phase symmetric calculation, even for asymmetric loads/generations (Default).
-                - False: Three-phase asymmetric calculation.
-            error_tolerance (float, optional): Error tolerance for voltage in p.u., applicable only when the
-                calculation method is iterative.
-            max_iterations (int, optional): Maximum number of iterations, applicable only when the calculation method
-                is iterative.
-            calculation_method (an enumeration or string): The calculation method to use.
-
-                - newton_raphson: Use Newton-Raphson iterative method (default).
-                - linear: Use linear method.
-            update_data (dict, optional):
-                None: Calculate power flow once with the current model attributes.
-                Or a dictionary for batch calculation with batch update.
-
-                    - key: Component type name to be updated in batch.
-                    - value:
-
-                        - For homogeneous update batch (a 2D numpy structured array):
-
-                            - Dimension 0: Each batch.
-                            - Dimension 1: Each updated element per batch for this component type.
-                        - For inhomogeneous update batch (a dictionary containing two keys):
-
-                            - indptr: A 1D numpy int64 array with length n_batch + 1. Given batch number k, the
-                              update array for this batch is data[indptr[k]:indptr[k + 1]]. This is the concept of
-                              compressed sparse structure.
-                              https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csr_matrix.html
-                            - data: 1D numpy structured array in flat.
-            threading (int, optional): Applicable only for batch calculation.
-
-                - < 0: Sequential
-                - = 0: Parallel, use number of hardware threads
-                - > 0: Specify number of parallel threads
-            output_component_types (ComponentAttributeMapping):
-
-                - None: Row based data for all component types.
-                - set[ComponentTypeVar] or list[ComponentTypeVar]: Row based data for the specified component types.
-                - ComponentAttributeFilterOptions: Columnar data for all component types.
-                - dict[ComponentType, set[str] | list[str] | None | ComponentAttributeFilterOptions]:
-                    key: ComponentType
-                    value:
-                        - None: Row based data for the specified component types.
-                        - ComponentAttributeFilterOptions: Columnar data for the specified component types.
-                        - set[str] | list[str]: Columnar data for the specified component types and attributes.
-            continue_on_batch_error (bool, optional):
-                Continue the program (instead of throwing error) if some scenarios fail.
-                You can still retrieve the errors and succeeded/failed scenarios via the batch_error.
-            decode_error (bool, optional):
-                Decode error messages to their derived types if possible.
-
-        Returns:
-            Dictionary of results of all components.
-
-                - key: Component type name to be updated in batch.
-                - value:
-
-                    - For single calculation: 1D numpy structured array for the results of this component type.
-                    - For batch calculation: 2D numpy structured array for the results of this component type.
-
-                        - Dimension 0: Each batch.
-                        - Dimension 1: The result of each element for this component type.
-
-        Raises:
-            Exception: In case an error in the core occurs, an exception will be thrown.
-        """
-        return self._calculate_power_flow(
-            symmetric=symmetric,
-            error_tolerance=error_tolerance,
-            max_iterations=max_iterations,
-            calculation_method=calculation_method,
-            update_data=(_map_to_component_types(update_data) if update_data is not None else None),
-            threading=threading,
-            output_component_types=output_component_types,
-            continue_on_batch_error=continue_on_batch_error,
-            decode_error=decode_error,
-            tap_changing_strategy=tap_changing_strategy,
-        )
-
-    def calculate_state_estimation(  # noqa: PLR0913
-        self,
-        *,
-        symmetric: bool = True,
-        error_tolerance: float = 1e-8,
-        max_iterations: int = 20,
-        calculation_method: CalculationMethod | str = CalculationMethod.iterative_linear,
-        update_data: dict[str, np.ndarray | dict[str, np.ndarray]] | Dataset | None = None,
-        threading: int = -1,
-        output_component_types: ComponentAttributeMapping = None,
-        continue_on_batch_error: bool = False,
-        decode_error: bool = True,
-    ) -> dict[ComponentType, np.ndarray]:
-        """
-        Calculate state estimation once with the current model attributes.
-        Or calculate in batch with the given update dataset in batch.
-
-        Args:
-            symmetric (bool, optional): Whether to perform a three-phase symmetric calculation.
-
-                - True: Three-phase symmetric calculation, even for asymmetric loads/generations (Default).
-                - False: Three-phase asymmetric calculation.
-            error_tolerance (float, optional): error tolerance for voltage in p.u., only applicable when the
-                calculation method is iterative.
-            max_iterations (int, optional): Maximum number of iterations, applicable only when the calculation method
-                is iterative.
-            calculation_method (an enumeration): Use iterative linear method.
-            update_data (dict, optional):
-                None: Calculate state estimation once with the current model attributes.
-                Or a dictionary for batch calculation with batch update.
-
-                    - key: Component type name to be updated in batch.
-                    - value:
-
-                        - For homogeneous update batch (a 2D numpy structured array):
-
-                            - Dimension 0: Each batch.
-                            - Dimension 1: Each updated element per batch for this component type.
-                        - For inhomogeneous update batch (a dictionary containing two keys):
-
-                            - indptr: A 1D numpy int64 array with length n_batch + 1. Given batch number k, the
-                              update array for this batch is data[indptr[k]:indptr[k + 1]]. This is the concept of
-                              compressed sparse structure.
-                              https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csr_matrix.html
-                            - data: 1D numpy structured array in flat.
-            threading (int, optional): Applicable only for batch calculation.
-
-                - < 0: Sequential
-                - = 0: Parallel, use number of hardware threads
-                - > 0: Specify number of parallel threads
-            output_component_types (ComponentAttributeMapping):
-
-                - None: Row based data for all component types.
-                - set[ComponentTypeVar] or list[ComponentTypeVar]: Row based data for the specified component types.
-                - ComponentAttributeFilterOptions: Columnar data for all component types.
-                - dict[ComponentType, set[str] | list[str] | None | ComponentAttributeFilterOptions]:
-                    key: ComponentType
-                    value:
-                        - None: Row based data for the specified component types.
-                        - ComponentAttributeFilterOptions: Columnar data for the specified component types.
-                        - set[str] | list[str]: Columnar data for the specified component types and attributes.
-            continue_on_batch_error (bool, optional):
-                Continue the program (instead of throwing error) if some scenarios fail.
-                You can still retrieve the errors and succeeded/failed scenarios via the batch_error.
-            decode_error (bool, optional):
-                Decode error messages to their derived types if possible.
-
-        Returns:
-            Dictionary of results of all components.
-
-                - key: Component type name to be updated in batch.
-                - value:
-
-                    - For single calculation: 1D numpy structured array for the results of this component type.
-                    - For batch calculation: 2D numpy structured array for the results of this component type.
-
-                        - Dimension 0: Each batch.
-                        - Dimension 1: The result of each element for this component type.
-
-        Raises:
-            Exception: In case an error in the core occurs, an exception will be thrown.
-        """
-        return self._calculate_state_estimation(
-            symmetric=symmetric,
-            error_tolerance=error_tolerance,
-            max_iterations=max_iterations,
-            calculation_method=calculation_method,
-            update_data=(_map_to_component_types(update_data) if update_data is not None else None),
-            threading=threading,
-            output_component_types=output_component_types,
-            continue_on_batch_error=continue_on_batch_error,
-            decode_error=decode_error,
-        )
-
-    def calculate_short_circuit(  # noqa: PLR0913
-        self,
-        *,
-        calculation_method: CalculationMethod | str = CalculationMethod.iec60909,
-        update_data: dict[str, np.ndarray | dict[str, np.ndarray]] | Dataset | None = None,
-        threading: int = -1,
-        output_component_types: ComponentAttributeMapping = None,
-        continue_on_batch_error: bool = False,
-        decode_error: bool = True,
-        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str = ShortCircuitVoltageScaling.maximum,
-    ) -> dict[ComponentType, np.ndarray]:
-        """
-        Calculate a short circuit once with the current model attributes.
-        Or calculate in batch with the given update dataset in batch
-
-        Args:
-            calculation_method (an enumeration): Use the iec60909 standard.
-            update_data:
-                None: calculate a short circuit once with the current model attributes.
-                Or a dictionary for batch calculation with batch update
-
-                    - key: Component type name to be updated in batch
-                    - value:
-
-                        - For homogeneous update batch (a 2D numpy structured array):
-
-                            - Dimension 0: each batch
-                            - Dimension 1: each updated element per batch for this component type
-                        - For inhomogeneous update batch (a dictionary containing two keys):
-
-                            - indptr: A 1D numpy int64 array with length n_batch + 1. Given batch number k, the
-                              update array for this batch is data[indptr[k]:indptr[k + 1]]. This is the concept of
-                              compressed sparse structure.
-                              https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csr_matrix.html
-                            - data: 1D numpy structured array in flat.
-            threading (int, optional): Applicable only for batch calculation.
-
-                - < 0: Sequential
-                - = 0: Parallel, use number of hardware threads
-                - > 0: Specify number of parallel threads
-            output_component_types (ComponentAttributeMapping):
-
-                - None: Row based data for all component types.
-                - set[ComponentTypeVar] or list[ComponentTypeVar]: Row based data for the specified component types.
-                - ComponentAttributeFilterOptions: Columnar data for all component types.
-                - dict[ComponentType, set[str] | list[str] | None | ComponentAttributeFilterOptions]:
-                    key: ComponentType
-                    value:
-                        - None: Row based data for the specified component types.
-                        - ComponentAttributeFilterOptions: Columnar data for the specified component types.
-                        - set[str] | list[str]: Columnar data for the specified component types and attributes.
-            continue_on_batch_error (bool, optional):
-                Continue the program (instead of throwing error) if some scenarios fail.
-                You can still retrieve the errors and succeeded/failed scenarios via the batch_error.
-            decode_error (bool, optional):
-                Decode error messages to their derived types if possible.
-            short_circuit_voltage_scaling ({ShortCircuitVoltageSaling, str}, optional):
-                Whether to use the maximum or minimum voltage scaling.
-                By default, the maximum voltage scaling is used to calculate the short circuit.
-
-        Returns:
-            Dictionary of results of all components.
-
-                - key: Component type name to be updated in batch.
-                - value:
-
-                    - For single calculation: 1D numpy structured array for the results of this component type.
-                    - For batch calculation: 2D numpy structured array for the results of this component type.
-
-                        - Dimension 0: Each batch.
-                        - Dimension 1: The result of each element for this component type.
-        Raises:
-            Exception: In case an error in the core occurs, an exception will be thrown.
-        """
-        return self._calculate_short_circuit(
-            calculation_method=calculation_method,
-            update_data=(_map_to_component_types(update_data) if update_data is not None else None),
-            threading=threading,
-            output_component_types=output_component_types,
-            continue_on_batch_error=continue_on_batch_error,
-            decode_error=decode_error,
-            short_circuit_voltage_scaling=short_circuit_voltage_scaling,
-        )
-
-    def __del__(self):
-        pgc.destroy_model(self._model_ptr)
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+"""
+Main power grid model class
+"""
+
+from enum import IntEnum
+from typing import Any, overload
+
+import numpy as np
+
+from power_grid_model._core.data_handling import (
+    create_output_data,
+    get_output_type,
+    prepare_input_view,
+    prepare_output_view,
+    prepare_update_view,
+)
+from power_grid_model._core.data_types import (
+    BatchDataset,
+    Dataset,
+    DenseBatchColumnarOutputDataset,
+    DenseBatchOutputDataset,
+    DenseBatchRowBasedOutputDataset,
+    SingleColumnarOutputDataset,
+    SingleDataset,
+    SingleOutputDataset,
+    SingleRowBasedDataset,
+    SingleRowBasedOutputDataset,
+)
+from power_grid_model._core.dataset_definitions import (
+    ComponentType,
+    ComponentTypeLike,
+    ComponentTypeVar,
+    _map_to_component_types,
+    _str_to_component_type,
+)
+from power_grid_model._core.enum import (
+    CalculationMethod,
+    CalculationType,
+    ComponentAttributeFilterOptions,
+    ShortCircuitVoltageScaling,
+    TapChangingStrategy,
+    _ExperimentalFeatures,
+)
+from power_grid_model._core.error_handling import PowerGridBatchError, assert_no_error, handle_errors
+from power_grid_model._core.index_integer import IdNp, IdxNp
+from power_grid_model._core.options import Options
+from power_grid_model._core.power_grid_core import ConstDatasetPtr, IDPtr, IdxPtr, ModelPtr, power_grid_core as pgc
+from power_grid_model._core.typing import ComponentAttributeMapping, ComponentAttributeMappingDict
+
+
+class PowerGridModel:
+    """
+    Main class for Power Grid Model
+    """
+
+    _model_ptr: ModelPtr
+    _all_component_count: dict[ComponentType, int] | None
+    _batch_error: PowerGridBatchError | None
+
+    @property
+    def batch_error(self) -> PowerGridBatchError | None:
+        """
+        Get the batch error object, if present, after a batch calculation with errors.
+
+        Also works when continue_on_batch_error was set to True during the calculation.
+
+        Returns:
+            Batch error object, or None
+        """
+        return self._batch_error
+
+    @property
+    def _model(self):
+        if not self._model_ptr:
+            raise TypeError("You have an empty instance of PowerGridModel!")
+        return self._model_ptr
+
+    @property
+    def all_component_count(self) -> dict[ComponentType, int]:
+        """
+        Get amount of elements per component type.
+        If the count for a component type is zero, it will not be in the returned dictionary.
+
+        Returns:
+            A dictionary with
+
+                - key: Component type name
+                - value: Integer count of elements of this type
+        """
+        if self._all_component_count is None:
+            raise TypeError("You have an empty instance of PowerGridModel!")
+        return self._all_component_count
+
+    def copy(self) -> "PowerGridModel":
+        """
+        Copy the current model
+
+        Returns:
+            A copy of PowerGridModel
+        """
+        new_model = PowerGridModel.__new__(PowerGridModel)
+        new_model._model_ptr = pgc.copy_model(self._model)
+        assert_no_error()
+        new_model._all_component_count = self._all_component_count
+        return new_model
+
+    def __copy__(self) -> "PowerGridModel":
+        return self.copy()
+
+    def __deepcopy__(self, memo: dict[int, Any]) -> "PowerGridModel":
+        # PowerGridModel.copy makes already a deepcopy
+        new_model = self.copy()
+
+        # memorize that this object (self) has been deepcopied
+        memo[id(self)] = new_model
+
+        return new_model
+
+    def __new__(cls, *_args, **_kwargs):
+        instance = super().__new__(cls)
+        instance._model_ptr = ModelPtr()
+        instance._all_component_count = None
+        return instance
+
+    def __init__(self, input_data: SingleDataset, system_frequency: float = 50.0):
+        """
+        Initialize the model from an input data set.
+
+        Args:
+            input_data: Input data dictionary
+
+                - key: Component type
+                - value: Component data with the correct type :class:`SingleComponentData`
+
+            system_frequency: Frequency of the power system, default 50 Hz
+        """
+        # destroy old instance
+        pgc.destroy_model(self._model_ptr)
+        self._all_component_count = None
+        # create new
+        prepared_input = prepare_input_view(_map_to_component_types(input_data))
+        self._model_ptr = pgc.create_model(system_frequency, input_data=prepared_input.get_dataset_ptr())
+        assert_no_error()
+        self._all_component_count = {k: v for k, v in prepared_input.get_info().total_elements().items() if v > 0}
+
+    def update(self, *, update_data: Dataset):
+        """
+        Update the model with changes.
+
+        The model will be in an invalid state if the update fails and should be discarded.
+
+        Args:
+            update_data: Update data dictionary
+
+                - key: Component type
+                - value: Component data with the correct type :class:`ComponentData` (single scenario or batch)
+
+        Raises:
+            PowerGridError if the update fails. The model is left in an invalid state and should be discarded.
+
+        Returns:
+            None
+        """
+        prepared_update = prepare_update_view(_map_to_component_types(update_data))
+        pgc.update_model(self._model, prepared_update.get_dataset_ptr())
+        assert_no_error()
+
+    def get_indexer(self, component_type: ComponentTypeLike, ids: np.ndarray):
+        """
+        Get array of indexers given array of ids for component type.
+
+        This enables syntax like input_data[ComponentType.node][get_indexer(ids)]
+
+        Args:
+            component_type: Type of component
+            ids: Array of ids
+
+        Returns:
+            Array of indexers, same shape as input array ids
+        """
+        component_type = _str_to_component_type(component_type)
+        ids_c = np.ascontiguousarray(ids, dtype=IdNp).ctypes.data_as(IDPtr)
+        indexer = np.empty_like(ids, dtype=IdxNp, order="C")
+        indexer_c = indexer.ctypes.data_as(IdxPtr)
+        size = ids.size
+        # call c function
+        pgc.get_indexer(self._model, component_type, size, ids_c, indexer_c)
+        assert_no_error()
+        return indexer
+
+    def _get_output_component_count(self, calculation_type: CalculationType):
+        exclude_types = {
+            CalculationType.power_flow: [
+                ComponentType.sym_voltage_sensor,
+                ComponentType.asym_voltage_sensor,
+                ComponentType.sym_power_sensor,
+                ComponentType.asym_power_sensor,
+                ComponentType.fault,
+            ],
+            CalculationType.state_estimation: [ComponentType.fault],
+            CalculationType.short_circuit: [
+                ComponentType.sym_voltage_sensor,
+                ComponentType.asym_voltage_sensor,
+                ComponentType.sym_power_sensor,
+                ComponentType.asym_power_sensor,
+            ],
+        }.get(calculation_type, [])
+
+        def include_type(component_type: ComponentType):
+            return all(exclude_type.value not in component_type.value for exclude_type in exclude_types)
+
+        return {ComponentType[k]: v for k, v in self.all_component_count.items() if include_type(k)}
+
+    def _construct_output(
+        self,
+        output_component_types: ComponentAttributeMapping,
+        calculation_type: CalculationType,
+        symmetric: bool,
+        is_batch: bool,
+        batch_size: int,
+    ):
+        all_component_count = self._get_output_component_count(calculation_type=calculation_type)
+        return create_output_data(
+            output_component_types=output_component_types,
+            output_type=get_output_type(calculation_type=calculation_type, symmetric=symmetric),
+            all_component_count=all_component_count,
+            is_batch=is_batch,
+            batch_size=batch_size,
+        )
+
+    @staticmethod
+    def _options(**kwargs) -> Options:
+        def as_enum_value(key_enum: str, type_: type[IntEnum]):
+            if key_enum in kwargs:
+                value_enum = kwargs[key_enum]
+                if isinstance(value_enum, str):
+                    kwargs[key_enum] = type_[value_enum]  # NOSONAR(S5864) IntEnum has __getitem__
+
+        as_enum_value("calculation_method", CalculationMethod)
+        as_enum_value("tap_changing_strategy", TapChangingStrategy)
+        as_enum_value("short_circuit_voltage_scaling", ShortCircuitVoltageScaling)
+        as_enum_value("experimental_features", _ExperimentalFeatures)
+
+        opt = Options()
+        for key, value in kwargs.items():
+            setattr(opt, key, value.value if isinstance(value, IntEnum) else value)
+        return opt
+
+    def _handle_errors(self, continue_on_batch_error: bool, batch_size: int, decode_error: bool):
+        self._batch_error = handle_errors(
+            continue_on_batch_error=continue_on_batch_error,
+            batch_size=batch_size,
+            decode_error=decode_error,
+        )
+
+    def _calculate_impl(  # noqa: PLR0913
+        self,
+        calculation_type: CalculationType,
+        symmetric: bool,
+        update_data: Dataset | None,
+        output_component_types: ComponentAttributeMapping,
+        options: Options,
+        continue_on_batch_error: bool,
+        decode_error: bool,
+        experimental_features: _ExperimentalFeatures | str,  # NOSONAR # noqa: ARG002
+    ) -> Dataset:
+        """
+        Core calculation routine
+
+        Args:
+            calculation_type:
+            symmetric:
+            update_data:
+            output_component_types:
+            options:
+            continue_on_batch_error:
+            decode_error:
+
+        Returns:
+        """
+        self._batch_error = None
+        is_batch = update_data is not None
+
+        if update_data is not None:
+            prepared_update = prepare_update_view(update_data)
+            update_ptr = prepared_update.get_dataset_ptr()
+            batch_size = prepared_update.get_info().batch_size()
+        else:
+            update_ptr = ConstDatasetPtr()
+            batch_size = 1
+
+        output_data = self._construct_output(
+            output_component_types=output_component_types,
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            is_batch=is_batch,
+            batch_size=batch_size,
+        )
+        prepared_result = prepare_output_view(
+            output_data=output_data,
+            output_type=get_output_type(calculation_type=calculation_type, symmetric=symmetric),
+        )
+
+        # run calculation
+        pgc.calculate(
+            # model and options
+            self._model,
+            options.opt,
+            output_data=prepared_result.get_dataset_ptr(),
+            update_data=update_ptr,
+        )
+
+        self._handle_errors(
+            continue_on_batch_error=continue_on_batch_error,
+            batch_size=batch_size,
+            decode_error=decode_error,
+        )
+
+        return output_data
+
+    def _calculate_power_flow(  # noqa: PLR0913
+        self,
+        *,
+        symmetric: bool = True,
+        error_tolerance: float = 1e-8,
+        max_iterations: int = 20,
+        calculation_method: CalculationMethod | str = CalculationMethod.newton_raphson,
+        update_data: Dataset | None = None,
+        threading: int = -1,
+        output_component_types: ComponentAttributeMapping = None,
+        continue_on_batch_error: bool = False,
+        decode_error: bool = True,
+        tap_changing_strategy: TapChangingStrategy | str = TapChangingStrategy.disabled,
+        experimental_features: _ExperimentalFeatures | str = _ExperimentalFeatures.disabled,
+    ) -> Dataset:
+        calculation_type = CalculationType.power_flow
+        options = self._options(
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            error_tolerance=error_tolerance,
+            max_iterations=max_iterations,
+            calculation_method=calculation_method,
+            tap_changing_strategy=tap_changing_strategy,
+            threading=threading,
+            experimental_features=experimental_features,
+        )
+        return self._calculate_impl(
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            update_data=update_data,
+            output_component_types=output_component_types,
+            options=options,
+            continue_on_batch_error=continue_on_batch_error,
+            decode_error=decode_error,
+            experimental_features=experimental_features,
+        )
+
+    def _calculate_state_estimation(  # noqa: PLR0913
+        self,
+        *,
+        symmetric: bool = True,
+        error_tolerance: float = 1e-8,
+        max_iterations: int = 20,
+        calculation_method: CalculationMethod | str = CalculationMethod.iterative_linear,
+        update_data: Dataset | None = None,
+        threading: int = -1,
+        output_component_types: ComponentAttributeMapping = None,
+        continue_on_batch_error: bool = False,
+        decode_error: bool = True,
+        experimental_features: _ExperimentalFeatures | str = _ExperimentalFeatures.disabled,
+    ) -> Dataset:
+        calculation_type = CalculationType.state_estimation
+        options = self._options(
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            error_tolerance=error_tolerance,
+            max_iterations=max_iterations,
+            calculation_method=calculation_method,
+            threading=threading,
+            experimental_features=experimental_features,
+        )
+        return self._calculate_impl(
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            update_data=update_data,
+            output_component_types=output_component_types,
+            options=options,
+            continue_on_batch_error=continue_on_batch_error,
+            decode_error=decode_error,
+            experimental_features=experimental_features,
+        )
+
+    def _calculate_short_circuit(  # noqa: PLR0913
+        self,
+        *,
+        calculation_method: CalculationMethod | str = CalculationMethod.iec60909,
+        update_data: Dataset | None = None,
+        threading: int = -1,
+        output_component_types: ComponentAttributeMapping = None,
+        continue_on_batch_error: bool = False,
+        decode_error: bool = True,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str = ShortCircuitVoltageScaling.maximum,
+        experimental_features: _ExperimentalFeatures | str = _ExperimentalFeatures.disabled,
+    ) -> Dataset:
+        calculation_type = CalculationType.short_circuit
+        symmetric = False
+
+        options = self._options(
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            calculation_method=calculation_method,
+            threading=threading,
+            short_circuit_voltage_scaling=short_circuit_voltage_scaling,
+            experimental_features=experimental_features,
+        )
+        return self._calculate_impl(
+            calculation_type=calculation_type,
+            symmetric=symmetric,
+            update_data=update_data,
+            output_component_types=output_component_types,
+            options=options,
+            continue_on_batch_error=continue_on_batch_error,
+            decode_error=decode_error,
+            experimental_features=experimental_features,
+        )
+
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> SingleRowBasedDataset: ...
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> SingleRowBasedDataset: ...
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeFilterOptions = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> SingleColumnarOutputDataset: ...
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeMappingDict = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> SingleOutputDataset: ...
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> DenseBatchRowBasedOutputDataset: ...
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeFilterOptions = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> DenseBatchColumnarOutputDataset: ...
+    @overload
+    def calculate_power_flow(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeMappingDict = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        tap_changing_strategy: TapChangingStrategy | str = ...,
+    ) -> DenseBatchOutputDataset: ...
+    def calculate_power_flow(  # noqa: PLR0913
+        self,
+        *,
+        symmetric: bool = True,
+        error_tolerance: float = 1e-8,
+        max_iterations: int = 20,
+        calculation_method: CalculationMethod | str = CalculationMethod.newton_raphson,
+        update_data: BatchDataset | None = None,
+        threading: int = -1,
+        output_component_types: ComponentAttributeMapping = None,
+        continue_on_batch_error: bool = False,
+        decode_error: bool = True,
+        tap_changing_strategy: TapChangingStrategy | str = TapChangingStrategy.disabled,
+    ) -> Dataset:
+        """
+        Calculate power flow once with the current model attributes.
+        Or calculate in batch with the given update dataset in batch.
+
+        Args:
+            symmetric (bool, optional): Whether to perform a three-phase symmetric calculation.
+
+                - True: Three-phase symmetric calculation, even for asymmetric loads/generations (Default).
+                - False: Three-phase asymmetric calculation.
+            error_tolerance (float, optional): Error tolerance for voltage in p.u., applicable only when the
+                calculation method is iterative.
+            max_iterations (int, optional): Maximum number of iterations, applicable only when the calculation method
+                is iterative.
+            calculation_method (an enumeration or string): The calculation method to use.
+
+                - newton_raphson: Use Newton-Raphson iterative method (default).
+                - linear: Use linear method.
+            update_data (dict, optional):
+                None: Calculate power flow once with the current model attributes.
+                Or a dictionary for batch calculation with batch update.
+
+                    - key: Component type name to be updated in batch.
+                    - value:
+
+                        - For homogeneous update batch (a 2D numpy structured array):
+
+                            - Dimension 0: Each batch.
+                            - Dimension 1: Each updated element per batch for this component type.
+                        - For inhomogeneous update batch (a dictionary containing two keys):
+
+                            - indptr: A 1D numpy int64 array with length n_batch + 1. Given batch number k, the
+                              update array for this batch is data[indptr[k]:indptr[k + 1]]. This is the concept of
+                              compressed sparse structure.
+                              https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csr_matrix.html
+                            - data: 1D numpy structured array in flat.
+            threading (int, optional): Applicable only for batch calculation.
+
+                - < 0: Sequential
+                - = 0: Parallel, use number of hardware threads
+                - > 0: Specify number of parallel threads
+            output_component_types (ComponentAttributeMapping):
+
+                - None: Row based data for all component types.
+                - set[ComponentTypeVar] or list[ComponentTypeVar]: Row based data for the specified component types.
+                - ComponentAttributeFilterOptions: Columnar data for all component types.
+                - ComponentAttributeMappingDict:
+                    key: ComponentType
+                    value:
+                        - None: Row based data for the specified component types.
+                        - ComponentAttributeFilterOptions: Columnar data for the specified component types.
+                        - set[str] | list[str]: Columnar data for the specified component types and attributes.
+            continue_on_batch_error (bool, optional):
+                Continue the program (instead of throwing error) if some scenarios fail.
+                You can still retrieve the errors and succeeded/failed scenarios via the batch_error.
+            decode_error (bool, optional):
+                Decode error messages to their derived types if possible.
+
+        Returns:
+            Dictionary of results of all components.
+
+                - key: Component type name to be updated in batch.
+                - value:
+
+                    - For single calculation: 1D numpy structured array for the results of this component type.
+                    - For batch calculation: 2D numpy structured array for the results of this component type.
+
+                        - Dimension 0: Each batch.
+                        - Dimension 1: The result of each element for this component type.
+
+        Raises:
+            Exception: In case an error in the core occurs, an exception will be thrown.
+        """
+        return self._calculate_power_flow(
+            symmetric=symmetric,
+            error_tolerance=error_tolerance,
+            max_iterations=max_iterations,
+            calculation_method=calculation_method,
+            update_data=(_map_to_component_types(update_data) if update_data is not None else None),
+            threading=threading,
+            output_component_types=output_component_types,
+            continue_on_batch_error=continue_on_batch_error,
+            decode_error=decode_error,
+            tap_changing_strategy=tap_changing_strategy,
+        )
+
+    @overload
+    def calculate_state_estimation(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+    ) -> SingleRowBasedOutputDataset: ...
+    @overload
+    def calculate_state_estimation(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeFilterOptions = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+    ) -> SingleColumnarOutputDataset: ...
+    @overload
+    def calculate_state_estimation(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeMappingDict = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+    ) -> SingleOutputDataset: ...
+    @overload
+    def calculate_state_estimation(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+    ) -> DenseBatchRowBasedOutputDataset: ...
+    @overload
+    def calculate_state_estimation(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeFilterOptions = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+    ) -> DenseBatchColumnarOutputDataset: ...
+    @overload
+    def calculate_state_estimation(
+        self,
+        *,
+        symmetric: bool = ...,
+        error_tolerance: float = ...,
+        max_iterations: int = ...,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeMappingDict = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+    ) -> DenseBatchOutputDataset: ...
+    def calculate_state_estimation(  # noqa: PLR0913
+        self,
+        *,
+        symmetric: bool = True,
+        error_tolerance: float = 1e-8,
+        max_iterations: int = 20,
+        calculation_method: CalculationMethod | str = CalculationMethod.iterative_linear,
+        update_data: BatchDataset | None = None,
+        threading: int = -1,
+        output_component_types: ComponentAttributeMapping = None,
+        continue_on_batch_error: bool = False,
+        decode_error: bool = True,
+    ) -> Dataset:
+        """
+        Calculate state estimation once with the current model attributes.
+        Or calculate in batch with the given update dataset in batch.
+
+        Args:
+            symmetric (bool, optional): Whether to perform a three-phase symmetric calculation.
+
+                - True: Three-phase symmetric calculation, even for asymmetric loads/generations (Default).
+                - False: Three-phase asymmetric calculation.
+            error_tolerance (float, optional): error tolerance for voltage in p.u., only applicable when the
+                calculation method is iterative.
+            max_iterations (int, optional): Maximum number of iterations, applicable only when the calculation method
+                is iterative.
+            calculation_method (an enumeration): Use iterative linear method.
+            update_data (dict, optional):
+                None: Calculate state estimation once with the current model attributes.
+                Or a dictionary for batch calculation with batch update.
+
+                    - key: Component type name to be updated in batch.
+                    - value:
+
+                        - For homogeneous update batch (a 2D numpy structured array):
+
+                            - Dimension 0: Each batch.
+                            - Dimension 1: Each updated element per batch for this component type.
+                        - For inhomogeneous update batch (a dictionary containing two keys):
+
+                            - indptr: A 1D numpy int64 array with length n_batch + 1. Given batch number k, the
+                              update array for this batch is data[indptr[k]:indptr[k + 1]]. This is the concept of
+                              compressed sparse structure.
+                              https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csr_matrix.html
+                            - data: 1D numpy structured array in flat.
+            threading (int, optional): Applicable only for batch calculation.
+
+                - < 0: Sequential
+                - = 0: Parallel, use number of hardware threads
+                - > 0: Specify number of parallel threads
+            output_component_types (ComponentAttributeMapping):
+
+                - None: Row based data for all component types.
+                - set[ComponentTypeVar] or list[ComponentTypeVar]: Row based data for the specified component types.
+                - ComponentAttributeFilterOptions: Columnar data for all component types.
+                - ComponentAttributeMappingDict:
+                    key: ComponentType
+                    value:
+                        - None: Row based data for the specified component types.
+                        - ComponentAttributeFilterOptions: Columnar data for the specified component types.
+                        - set[str] | list[str]: Columnar data for the specified component types and attributes.
+            continue_on_batch_error (bool, optional):
+                Continue the program (instead of throwing error) if some scenarios fail.
+                You can still retrieve the errors and succeeded/failed scenarios via the batch_error.
+            decode_error (bool, optional):
+                Decode error messages to their derived types if possible.
+
+        Returns:
+            Dictionary of results of all components.
+
+                - key: Component type name to be updated in batch.
+                - value:
+
+                    - For single calculation: 1D numpy structured array for the results of this component type.
+                    - For batch calculation: 2D numpy structured array for the results of this component type.
+
+                        - Dimension 0: Each batch.
+                        - Dimension 1: The result of each element for this component type.
+
+        Raises:
+            Exception: In case an error in the core occurs, an exception will be thrown.
+        """
+        return self._calculate_state_estimation(
+            symmetric=symmetric,
+            error_tolerance=error_tolerance,
+            max_iterations=max_iterations,
+            calculation_method=calculation_method,
+            update_data=(_map_to_component_types(update_data) if update_data is not None else None),
+            threading=threading,
+            output_component_types=output_component_types,
+            continue_on_batch_error=continue_on_batch_error,
+            decode_error=decode_error,
+        )
+
+    @overload
+    def calculate_short_circuit(
+        self,
+        *,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str,
+    ) -> SingleRowBasedDataset: ...
+    @overload
+    def calculate_short_circuit(
+        self,
+        *,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeFilterOptions = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str,
+    ) -> SingleColumnarOutputDataset: ...
+    @overload
+    def calculate_short_circuit(
+        self,
+        *,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: None = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeMappingDict = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str,
+    ) -> SingleOutputDataset: ...
+    @overload
+    def calculate_short_circuit(
+        self,
+        *,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: None | set[ComponentTypeVar] | list[ComponentTypeVar] = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str,
+    ) -> DenseBatchRowBasedOutputDataset: ...
+    @overload
+    def calculate_short_circuit(
+        self,
+        *,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeFilterOptions = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str,
+    ) -> DenseBatchColumnarOutputDataset: ...
+    @overload
+    def calculate_short_circuit(
+        self,
+        *,
+        calculation_method: CalculationMethod | str = ...,
+        update_data: BatchDataset = ...,
+        threading: int = ...,
+        output_component_types: ComponentAttributeMappingDict = ...,
+        continue_on_batch_error: bool = ...,
+        decode_error: bool = ...,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str,
+    ) -> DenseBatchOutputDataset: ...
+    def calculate_short_circuit(  # noqa: PLR0913
+        self,
+        *,
+        calculation_method: CalculationMethod | str = CalculationMethod.iec60909,
+        update_data: BatchDataset | None = None,
+        threading: int = -1,
+        output_component_types: ComponentAttributeMapping = None,
+        continue_on_batch_error: bool = False,
+        decode_error: bool = True,
+        short_circuit_voltage_scaling: ShortCircuitVoltageScaling | str = ShortCircuitVoltageScaling.maximum,
+    ) -> Dataset:
+        """
+        Calculate a short circuit once with the current model attributes.
+        Or calculate in batch with the given update dataset in batch
+
+        Args:
+            calculation_method (an enumeration): Use the iec60909 standard.
+            update_data:
+                None: calculate a short circuit once with the current model attributes.
+                Or a dictionary for batch calculation with batch update
+
+                    - key: Component type name to be updated in batch
+                    - value:
+
+                        - For homogeneous update batch (a 2D numpy structured array):
+
+                            - Dimension 0: each batch
+                            - Dimension 1: each updated element per batch for this component type
+                        - For inhomogeneous update batch (a dictionary containing two keys):
+
+                            - indptr: A 1D numpy int64 array with length n_batch + 1. Given batch number k, the
+                              update array for this batch is data[indptr[k]:indptr[k + 1]]. This is the concept of
+                              compressed sparse structure.
+                              https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csr_matrix.html
+                            - data: 1D numpy structured array in flat.
+            threading (int, optional): Applicable only for batch calculation.
+
+                - < 0: Sequential
+                - = 0: Parallel, use number of hardware threads
+                - > 0: Specify number of parallel threads
+            output_component_types (ComponentAttributeMapping):
+
+                - None: Row based data for all component types.
+                - set[ComponentTypeVar] or list[ComponentTypeVar]: Row based data for the specified component types.
+                - ComponentAttributeFilterOptions: Columnar data for all component types.
+                - ComponentAttributeMappingDict:
+                    key: ComponentType
+                    value:
+                        - None: Row based data for the specified component types.
+                        - ComponentAttributeFilterOptions: Columnar data for the specified component types.
+                        - set[str] | list[str]: Columnar data for the specified component types and attributes.
+            continue_on_batch_error (bool, optional):
+                Continue the program (instead of throwing error) if some scenarios fail.
+                You can still retrieve the errors and succeeded/failed scenarios via the batch_error.
+            decode_error (bool, optional):
+                Decode error messages to their derived types if possible.
+            short_circuit_voltage_scaling ({ShortCircuitVoltageSaling, str}, optional):
+                Whether to use the maximum or minimum voltage scaling.
+                By default, the maximum voltage scaling is used to calculate the short circuit.
+
+        Returns:
+            Dictionary of results of all components.
+
+                - key: Component type name to be updated in batch.
+                - value:
+
+                    - For single calculation: 1D numpy structured array for the results of this component type.
+                    - For batch calculation: 2D numpy structured array for the results of this component type.
+
+                        - Dimension 0: Each batch.
+                        - Dimension 1: The result of each element for this component type.
+        Raises:
+            Exception: In case an error in the core occurs, an exception will be thrown.
+        """
+        return self._calculate_short_circuit(
+            calculation_method=calculation_method,
+            update_data=(_map_to_component_types(update_data) if update_data is not None else None),
+            threading=threading,
+            output_component_types=output_component_types,
+            continue_on_batch_error=continue_on_batch_error,
+            decode_error=decode_error,
+            short_circuit_voltage_scaling=short_circuit_voltage_scaling,
+        )
+
+    def __del__(self):
+        pgc.destroy_model(self._model_ptr)