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

power_grid_model/_core/power_grid_model_c/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0

power_grid_model/_core/power_grid_model_c/get_pgm_dll_path.py

@@ -0,0 +1,63 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+import os
+import platform
+from importlib.resources import files
+from pathlib import Path
+
+
+def get_pgm_dll_path() -> Path:
+    """
+    Returns the path to PGM dynamic library.
+    """
+    package_dir = Path(str(files(__package__)))
+    platform_name = platform.uname().system
+    if platform_name == "Windows":
+        lib_dir_1 = package_dir / "bin"
+        lib_dir_2 = package_dir / "bin"
+    else:
+        lib_dir_1 = package_dir / "lib"
+        lib_dir_2 = package_dir / "lib64"
+
+    # determine DLL file name
+    if platform_name == "Windows":
+        dll_file = Path("power_grid_model_c.dll")
+    elif platform_name == "Darwin":
+        dll_file = Path("libpower_grid_model_c.dylib")
+    elif platform.system() == "Linux":
+        dll_file = Path("libpower_grid_model_c.so")
+    else:
+        raise NotImplementedError(f"Unsupported platform: {platform_name}")
+    lib_dll_path_1 = lib_dir_1 / dll_file
+    lib_dll_path_2 = lib_dir_2 / dll_file
+
+    # determine editable path to the DLL
+    # __file__
+    #   -> power_grid_model_c (..)
+    #     -> _core (..)
+    #       -> power_grid_model (..)
+    #         -> src (..)
+    #           -> repo_root (..)
+    #             -> build
+    #               -> bin
+    editable_dir = Path(__file__).resolve().parent.parent.parent.parent.parent / "build" / "bin"
+    editable_dll_path = editable_dir / dll_file
+
+    # first try to load from lib_dll_path
+    # then editable_dll_path
+    # then if it is inside conda, just load dll_file, the system tries to find it in the PATH
+    # then for anything else, raise an error
+    if lib_dll_path_1.exists():
+        final_dll_path = lib_dll_path_1
+    elif lib_dll_path_2.exists():
+        final_dll_path = lib_dll_path_2
+    elif editable_dll_path.exists():
+        final_dll_path = editable_dll_path
+    elif os.environ.get("CONDA_PREFIX"):
+        final_dll_path = dll_file
+    else:
+        raise ImportError(f"Could not find shared library: {dll_file}. Your PGM installation may be broken.")
+
+    return final_dll_path

power_grid_model/_core/power_grid_model_c/include/power_grid_model_c/basics.h

@@ -0,0 +1,251 @@
+// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+//
+// SPDX-License-Identifier: MPL-2.0
+
+/**
+ * @brief Header file which includes basic type definitions
+ *
+ */
+
+#pragma once
+#ifndef POWER_GRID_MODEL_C_BASICS_H
+#define POWER_GRID_MODEL_C_BASICS_H
+
+// Generic helper definitions for shared library support
+// API_MACRO_BLOCK
+#if defined _WIN32
+#define PGM_HELPER_DLL_IMPORT __declspec(dllimport)
+#define PGM_HELPER_DLL_EXPORT __declspec(dllexport)
+#define PGM_HELPER_DLL_LOCAL
+#else
+#if __GNUC__ >= 4
+#define PGM_HELPER_DLL_IMPORT __attribute__((visibility("default")))
+#define PGM_HELPER_DLL_EXPORT __attribute__((visibility("default")))
+#define PGM_HELPER_DLL_LOCAL __attribute__((visibility("hidden")))
+#else
+#define PGM_HELPER_DLL_IMPORT
+#define PGM_HELPER_DLL_EXPORT
+#define PGM_HELPER_DLL_LOCAL
+#endif
+#endif
+// Now we use the generic helper definitions above to define PGM_API and PGM_LOCAL.
+#ifdef PGM_DLL_EXPORTS // defined if we are building the POWER_GRID_MODEL DLL (instead of using it)
+#define PGM_API PGM_HELPER_DLL_EXPORT
+#else
+#define PGM_API PGM_HELPER_DLL_IMPORT
+#endif // PGM_DLL_EXPORTS
+#define PGM_LOCAL PGM_HELPER_DLL_LOCAL
+// API_MACRO_BLOCK
+
+// integers
+#ifdef __cplusplus
+#include <cstddef>
+#include <cstdint>
+#else
+#include <stddef.h>
+#include <stdint.h>
+#endif
+
+// C linkage
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// NOLINTBEGIN(modernize-use-using)
+
+// index type
+typedef int64_t PGM_Idx;
+typedef int32_t PGM_ID;
+
+/**
+ * @brief Opaque struct for the PowerGridModel class.
+ *
+ */
+typedef struct PGM_PowerGridModel PGM_PowerGridModel;
+
+/**
+ * @brief Opaque struct for the handle class.
+ *
+ * The handle class is used to store error and information.
+ *
+ */
+typedef struct PGM_Handle PGM_Handle;
+
+/**
+ * @brief Opaque struct for the option class.
+ *
+ * The option class is used to set calculation options like calculation method.
+ *
+ */
+typedef struct PGM_Options PGM_Options;
+
+/**
+ * @brief Opaque struct for the attribute meta class.
+ *
+ * The attribute class contains all the meta information of a single attribute.
+ *
+ */
+typedef struct PGM_MetaAttribute PGM_MetaAttribute;
+
+/**
+ * @brief Opaque struct for the component meta class.
+ *
+ * The component class contains all the meta information of a single component.
+ *
+ */
+typedef struct PGM_MetaComponent PGM_MetaComponent;
+
+/**
+ * @brief Opaque struct for the dataset meta class
+ *
+ * The dataset class contains all the meta information of a single dataset.
+ *
+ */
+typedef struct PGM_MetaDataset PGM_MetaDataset;
+
+/**
+ * @brief Opaque struct for the serializer class.
+ */
+typedef struct PGM_Serializer PGM_Serializer;
+
+/**
+ * @brief Opaque struct for the deserializer class.
+ */
+typedef struct PGM_Deserializer PGM_Deserializer;
+
+/**
+ * @brief Opaque struct for the const dataset class.
+ */
+typedef struct PGM_ConstDataset PGM_ConstDataset;
+
+/**
+ * @brief Opaque struct for the multable dataset class.
+ * The mutable dataset is meant for the user to provide buffers to store the output of calculations.
+ */
+typedef struct PGM_MutableDataset PGM_MutableDataset;
+
+/**
+ * @brief Opaque struct for the writable dataset class.
+ * The writable dataset is meant for the user to provide buffers for the deserializer.
+ */
+typedef struct PGM_WritableDataset PGM_WritableDataset;
+
+/**
+ * @brief Opaque struct for the information of the dataset.
+ */
+typedef struct PGM_DatasetInfo PGM_DatasetInfo;
+
+// NOLINTEND(modernize-use-using)
+
+// NOLINTBEGIN(performance-enum-size)
+
+// enums
+/**
+ * @brief Enumeration for calculation type.
+ *
+ */
+enum PGM_CalculationType {
+    PGM_power_flow = 0,       /**< power flow calculation */
+    PGM_state_estimation = 1, /**< state estimation calculation */
+    PGM_short_circuit = 2     /**< short circuit calculation */
+};
+
+/**
+ * @brief Enumeration for calculation method.
+ *
+ */
+enum PGM_CalculationMethod {
+    PGM_default_method = -128, /**< the default method for each calculation type, e.g. Newton-Raphson for power flow */
+    PGM_linear = 0,            /**< linear constant impedance method for power flow */
+    PGM_newton_raphson = 1,    /**< Newton-Raphson method for power flow or state estimation */
+    PGM_iterative_linear = 2,  /**< iterative linear method for state estimation */
+    PGM_iterative_current = 3, /**< linear current method for power flow */
+    PGM_linear_current = 4,    /**< iterative constant impedance method for power flow */
+    PGM_iec60909 = 5           /**< fault analysis for short circuits using the iec60909 standard */
+};
+
+/**
+ * @brief Enumeration for calculation and/or component symmetry
+ */
+enum PGM_SymmetryType {
+    PGM_asymmetric = 0, /** < asymmetric calculation and/or component */
+    PGM_symmetric = 1   /** < symmetric calculation and/or component */
+};
+
+/**
+ * @brief Enumeration of error codes.
+ *
+ */
+enum PGM_ErrorCode {
+    PGM_no_error = 0,            /**< no error occurred */
+    PGM_regular_error = 1,       /**< some error occurred which is not in the batch calculation */
+    PGM_batch_error = 2,         /**< some error occurred which is in the batch calculation */
+    PGM_serialization_error = 3, /**< some error occurred which is in the (de)serialization process */
+};
+
+/**
+ * @brief Enumeration of C basic data types.
+ *
+ */
+enum PGM_CType {
+    PGM_int32 = 0,   /**< int32_t */
+    PGM_int8 = 1,    /**< int8_t */
+    PGM_double = 2,  /**< double */
+    PGM_double3 = 3, /**< double[3] */
+};
+
+/**
+ * @brief Enumeration of serialization types.
+ *
+ */
+enum PGM_SerializationFormat {
+    PGM_json = 0,    /**< JSON serialization format */
+    PGM_msgpack = 1, /**< msgpack serialization format */
+};
+
+/**
+ * @brief Enumeration of short circuit voltage scaling.
+ *
+ */
+enum PGM_ShortCircuitVoltageScaling {
+    PGM_short_circuit_voltage_scaling_minimum = 0, /**< voltage scaling for minimum short circuit currents */
+    PGM_short_circuit_voltage_scaling_maximum = 1, /**< voltage scaling for maximum short circuit currents */
+};
+
+/**
+ * @brief Enumeration of tap changing strategies.
+ *
+ */
+enum PGM_TapChangingStrategy {
+    PGM_tap_changing_strategy_disabled = 0, /**< disable automatic tap adjustment */
+    PGM_tap_changing_strategy_any_valid_tap =
+        1, /**< adjust tap position automatically; optimize for any value in the voltage band */
+    PGM_tap_changing_strategy_min_voltage_tap =
+        2, /**< adjust tap position automatically; optimize for the lower end of the voltage band */
+    PGM_tap_changing_strategy_max_voltage_tap =
+        3, /**< adjust tap position automatically; optimize for the higher end of the voltage band */
+    PGM_tap_changing_strategy_fast_any_tap =
+        4, /**< adjust tap position automatically; optimize for any value in the voltage band; binary search */
+};
+
+/**
+ * @brief Enumeration of experimental features.
+ *
+ * [Danger mode]
+ *
+ * The behavior of experimental features may not be final and no stability guarantees are made to the users.
+ * Which features (if any) are enabled in experimental mode may change over time.
+ *
+ */
+enum PGM_ExperimentalFeatures {
+    PGM_experimental_features_disabled = 0, /**< disable experimental features */
+    PGM_experimental_features_enabled = 1,  /**< enable experimental features */
+};
+
+// NOLINTEND(performance-enum-size)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

power_grid_model/_core/power_grid_model_c/include/power_grid_model_c/buffer.h

@@ -0,0 +1,108 @@
+// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+//
+// SPDX-License-Identifier: MPL-2.0
+
+/**
+ * @brief header file which includes buffer functions
+ *
+ */
+
+#pragma once
+#ifndef POWER_GRID_MODEL_C_BUFFER_H
+#define POWER_GRID_MODEL_C_BUFFER_H
+
+#include "basics.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Create a buffer with certain size and component type.
+ *
+ * You can use this function to allocate a (row-based) component buffer.
+ * You can also use your own allocation function to do that
+ * with size and alignment obtained from PGM_meta_component_size() and PGM_meta_component_alignment().
+ * The buffer created by this function should be freed by PGM_destroy_buffer().
+ *
+ * It is recommended to call PGM_buffer_set_nan() after you create an input or update buffer.
+ * In this way all the attributes will be set to NaN.
+ * Additionally, if there is a new optional attribute added in the future,
+ * compatibility with your code is guaranteed: that optional attribute will be set to NaN
+ * and the default value will be used.
+ *
+ * @param handle
+ * @param component A component pointer.
+ * @param size The size of the buffer in terms of number of elements.
+ * @return A pointer to the buffer, or NULL if the input is invalid.
+ */
+PGM_API void* PGM_create_buffer(PGM_Handle* handle, PGM_MetaComponent const* component, PGM_Idx size);
+
+/**
+ * @brief Destroy the buffer you created using PGM_create_buffer().
+ *
+ * NOTE: Do not call this function on the buffer you created using your own function.
+ *
+ * @param ptr The pointer to the buffer created using PGM_create_buffer().
+ */
+PGM_API void PGM_destroy_buffer(void* ptr);
+
+/**
+ * @brief Set all the attributes of a buffer to NaN.
+ *
+ * @param handle
+ * @param component A component pointer.
+ * @param ptr pointer to buffer, created either by PGM_create_buffer() or your own function.
+ * @param buffer_offset The offset in the buffer where you begin to set nan, in terms of number of elements.
+ * @param size The size of the buffer in terms of number of elements.
+ */
+PGM_API void PGM_buffer_set_nan(PGM_Handle* handle, PGM_MetaComponent const* component, void* ptr,
+                                PGM_Idx buffer_offset, PGM_Idx size);
+
+/**
+ * @brief Set value of a certain attribute from an array to the component buffer.
+ *
+ * You can use this function to set value.
+ * You can also set value by proper pointer arithmetric and casting,
+ * using the offset information returned by PGM_meta_attribute_offset().
+ *
+ * @param handle
+ * @param attribute An attribute pointer.
+ * @param buffer_ptr A pointer to the buffer.
+ * @param src_ptr A pointer to the source array you want to retrieve the value from.
+ * @param buffer_offset The offset in the buffer where you begin to set value, in terms of number of elements
+ * @param size The size of the buffer in terms of number of elements.
+ * @param src_stride The stride of the source array in bytes.
+ * You can set it to -1, the default stride of the size of the attribute type (like sizeof(double)).
+ * If you set it to a positive number, the i-th set-value will retrieve the source data at
+ * (void const*)((char const*)src_ptr + i * src_stride)
+ */
+PGM_API void PGM_buffer_set_value(PGM_Handle* handle, PGM_MetaAttribute const* attribute, void* buffer_ptr,
+                                  void const* src_ptr, PGM_Idx buffer_offset, PGM_Idx size, PGM_Idx src_stride);
+
+/**
+ * @brief Get value of a certain attribute from the component buffer to an array.
+ *
+ * You can use this function to get value.
+ * You can also get value by proper pointer arithmetric and casting,
+ * using the offset information returned by PGM_meta_attribute_offset().
+ *
+ * @param handle
+ * @param attribute An attribute pointer.
+ * @param buffer_ptr A pointer to the buffer.
+ * @param dest_ptr A pointer to the destination array you want to save the value to.
+ * @param buffer_offset The offset in the buffer where you begin to get value; in terms of number of elements.
+ * @param size The size of the buffer in terms of number of elements.
+ * @param dest_stride The stride of the destination array in bytes.
+ * You can set it to -1, the default stride of the size of the attribute type (like sizeof(double)).
+ * If you set it to a positive number, the i-th get-value will retrieve the source data at
+ * (void*)((char*)dest_ptr + i * dest_stride)
+ */
+PGM_API void PGM_buffer_get_value(PGM_Handle* handle, PGM_MetaAttribute const* attribute, void const* buffer_ptr,
+                                  void* dest_ptr, PGM_Idx buffer_offset, PGM_Idx size, PGM_Idx dest_stride);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif