Merge branch 'PowerGridModel:main' into main

.github/workflows/check-code-quality.yml

@@ -19,6 +19,8 @@ on:
   pull_request:
   # run pipeline on merge queue
   merge_group:
+  # run pipeline from another workflow
+  workflow_call:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}-code-quality
@@ -53,7 +55,7 @@ jobs:
 
       - name: Install and run mypy
         run: |
-          pip install mypy
+          pip install mypy numpy
           mypy .
 
       - name: Install and run pylint

.github/workflows/citations.yml

@@ -12,12 +12,13 @@ on:
     paths:
       - CITATION.cff
       - .github/workflows/citations.yml
-
   pull_request:
     paths:
       - CITATION.cff
       - .github/workflows/citations.yml
-
+  # run pipeline from another workflow
+  workflow_call:
+  # run this workflow manually from the Actions tab
   workflow_dispatch:
 
 concurrency:

.github/workflows/nightly.yml

@@ -22,7 +22,16 @@ jobs:
     with:
       create_release: false
 
+  check-code-quality:
+    uses: "./.github/workflows/check-code-quality.yml"
+
+  reuse-compliance:
+    uses: "./.github/workflows/reuse-compliance.yml"
+
   clang-tidy:
     uses: "./.github/workflows/clang-tidy.yml"
     with:
       target: "all power_grid_model_benchmark_cpp"
+
+  citations:
+    uses: "./.github/workflows/citations.yml"

.github/workflows/reuse-compliance.yml

@@ -13,6 +13,10 @@ on:
   pull_request:
   # run pipeline on merge queue
   merge_group:
+  # run pipeline from another workflow
+  workflow_call:
+  # run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}-reuse-compliance

.pre-commit-config.yaml

@@ -4,21 +4,23 @@
 
 repos:
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v3.0.2
+    rev: v4.0.3
     hooks:
       - id: reuse
   - repo: https://github.com/pycqa/isort
     rev: 5.13.2
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 24.4.2
+    rev: 24.8.0
     hooks:
       - id: black-jupyter
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.11.2
     hooks:
       - id: mypy
+        additional_dependencies:
+          - numpy
   - repo: local
     hooks:
       - id: pylint

REUSE.toml

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+version = 1
+SPDX-PackageName = "power-grid-model"
+SPDX-PackageSupplier = "Power Grid Model project <[email protected]>"
+SPDX-PackageDownloadLocation = "https://github.com/PowerGridModel/power-grid-model"
+
+[[annotations]]
+path = "./**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Contributors to the Power Grid Model project <[email protected]>"
+SPDX-License-Identifier = "MPL-2.0"

docs/api_reference/python-api-reference.md

@@ -34,6 +34,8 @@ SPDX-License-Identifier: MPL-2.0
 .. autoclass:: power_grid_model.data_types.SparseBatchArray
 .. autoclass:: power_grid_model.dataset_definitions.DatasetType
 .. autoclass:: power_grid_model.dataset_definitions.ComponentType
+.. autodata:: power_grid_model.typing.ComponentAttributeMapping
+   :annotation: ComponentAttributeMapping
 ```
 
 ## error types

docs/user_manual/serialization.md

@@ -28,7 +28,7 @@ The format consists of a [`PowerGridModelRoot`](#json-schema-root-object) JSON o
 
 - [`PowerGridModelRoot`](#json-schema-root-object): `Object`
   - `version`: `string` containing the schema version (required, current version is `"1.0"`)
-  - `type`: `string` containing the dataset type, e.g. `"input"`, `"update"`, ...
+  - `type`: `string` containing the dataset type, e.g. `"input"`, `"update"`, etc.
   - `is_batch`: `boolean` flag that describes whether the dataset is a batch or not.
   - `attributes`: [`Attributes`](#json-schema-attributes-object) containing specified attributes per component type (e.g.: `"node"`).
   - `data`: [`Dataset`](#json-schema-dataset-object) containing the actual dataset.

src/power_grid_model/__init__.py

@@ -12,6 +12,7 @@
     BranchSide,
     CalculationMethod,
     CalculationType,
+    ComponentAttributeFilterOptions,
     FaultPhase,
     FaultType,
     LoadGenType,
@@ -20,3 +21,4 @@
     TapChangingStrategy,
     WindingType,
 )
+from power_grid_model.typing import ComponentAttributeMapping