Merge branch 'feature/statistics-module' into feature/current-sensor-…

…impl
PowerGridModel · Feb 18, 2025 · 004d2bf · 004d2bf
2 parents 9883966 + 2cb1b9f
commit 004d2bf
Show file tree

Hide file tree

Showing 32 changed files with 1,302 additions and 217 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -13,6 +13,7 @@
 		"ms-toolsai.jupyter-renderers",
 		"ms-toolsai.vscode-jupyter-cell-tags",
 		"ms-toolsai.vscode-jupyter-slideshow",
+		"ms-toolsai.datawrangler",
 		"ms-vscode.cmake-tools",
 		"ms-vscode.cpptools",
 		"ms-vscode.cpptools-extension-pack",

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,7 +6,19 @@
     "cmake.configureSettings": {
         "POWER_GRID_MODEL_SANITIZER": 1
     },
-    "testMate.cpp.test.executables": "${command:cmake.buildDirectory}/bin/power_grid_model_*_tests",
+    "testMate.cpp.test.executables": "${command:cmake.buildDirectory}/bin/power_grid_model_*_tests*",
+    "testMate.cpp.debug.configTemplate": {
+        "type": "cppvsdbg",
+        "linux": { "type": "cppdbg", "MIMode": "gdb" },
+        "darwin": { "type": "cppdbg", "MIMode": "lldb" },
+        "win32": { "type": "cppvsdbg" },
+        "program": "${exec}",
+        "args": "${argsArray}",
+        "cwd": "${cwd}",
+        "env": "${envObj}",
+        "environment": "${envObjArray}",
+        "sourceFileMap": "${sourceFileMapObj}",
+    },
     "doxdocgen.generic.filteredKeywords": ["PGM_API"],
     "doxdocgen.generic.includeTypeAtReturn": false,
     "python.testing.pytestArgs": [

diff --git a/CITATION.cff b/CITATION.cff
@@ -14,18 +14,27 @@ authors:
     given-names: "Yu"
     email: "[email protected]"
     affiliation: "Alliander"
+    orcid: "https://orcid.org/0000-0001-5889-0067"
   - family-names: "Salemink"
     given-names: "Peter"
     email: "[email protected]"
     affiliation: "Alliander"
+  - family-names: "Westering"
+    name-particle: "van"
+    given-names: "Werner"
+    email: [email protected]
+    affiliation: "Alliander"
+    orcid: "https://orcid.org/0000-0002-4058-2581"
   - family-names: "Bharambe"
     given-names: "Nitish"
     email: "[email protected]"
     affiliation: "Alliander"
+    orcid: "https://orcid.org/0009-0007-9694-6077"
   - family-names: "Govers"
-    given-names: "Martinus"
+    given-names: "Martinus G.H."
     email: "[email protected]"
     affiliation: "Alliander"
+    orcid: "https://orcid.org/0009-0008-6890-8353"
   - family-names: "Bogaard"
     name-particle: "van den"
     given-names: "Jonas"
@@ -37,9 +46,15 @@ authors:
     given-names: "Zhen"
     email: "[email protected]"
     affiliation: "Alliander"
+    orcid: "https://orcid.org/0000-0003-4317-6455"
   - family-names: "Guo"
-    given-names: "Jerry"
-    email: "[email protected]"
+    given-names: "Jerry Jinfeng"
+    email: "[email protected]"
+    affiliation: "Alliander"
+    orcid: "https://orcid.org/0000-0002-8065-4084"
+  - family-names: "Figueroa Manrique"
+    given-names: "Santiago"
+    email: "[email protected]"
     affiliation: "Alliander"
   - family-names: "Jagutis"
     given-names: "Laurynas"
@@ -54,22 +69,20 @@ authors:
     given-names: "Marc"
     email: "[email protected]"
     affiliation: "Alliander"
-  - family-names: "Figueroa Manrique"
-    given-names: "Santiago"
-    email: "[email protected]"
-    affiliation: "Alliander" 
   - name: "Contributors to the LF Energy project Power Grid Model"
 contact:
   - name: "LF Energy project Power Grid Model"
-    email: "powergridmodel+help@lists.lfenergy.org"
+    email: "[email protected]"
 
 references:
   - title: "Power grid model: A high-performance distribution grid calculation library"
+    doi: "10.1049/icp.2023.0633"
     authors:
       - family-names: "Xiang"
         given-names: "Yu"
         email: [email protected]
         affiliation: "Alliander"
+        orcid: "https://orcid.org/0000-0001-5889-0067"
       - family-names: "Salemink"
         given-names: "Peter"
         email: [email protected]
@@ -80,16 +93,43 @@ references:
         given-names: "Nitish"
         email: [email protected]
         affiliation: "Alliander"
+        orcid: "https://orcid.org/0009-0007-9694-6077"
       - family-names: "Westering"
         name-particle: "van"
         given-names: "Werner"
+        email: [email protected]
+        affiliation: "Alliander"
+        orcid: "https://orcid.org/0000-0002-4058-2581"
     conference:
       name: "CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution"
     type: conference-paper
     year: 2023
     volume: 2023
     pages: "1-5"
 
+  - title: "PowerGridModel/power-grid-model-ds"
+    repository-code: "https://github.com/PowerGridModel/power-grid-model-ds"
+    doi: "10.5281/zenodo.14825565"
+    license: "MPL-2.0"
+    type: software-code
+    authors:
+      - family-names: "Schouten"
+        given-names: "Jaap"
+        email: [email protected]
+        affiliation: "Alliander"
+      - family-names: "Baaijen"
+        given-names: "Thijs"
+        email: [email protected]
+        affiliation: "Alliander"
+      - family-names: "Koppen"
+        given-names: "Vincent"
+        email: [email protected]
+      - family-names: "Voort"
+        name-particle: "van der"
+        given-names: "Sven"
+        email: [email protected]
+      - name: "Contributors to the LF Energy project Power Grid Model"
+
   - title: "PowerGridModel/power-grid-model-io"
     repository-code: "https://github.com/PowerGridModel/power-grid-model-io"
     doi: "10.5281/zenodo.8059257"
@@ -100,6 +140,7 @@ references:
         given-names: "Yu"
         email: "[email protected]"
         affiliation: "Alliander"
+        orcid: "https://orcid.org/0000-0001-5889-0067"
       - family-names: "Salemink"
         given-names: "Peter"
         email: "[email protected]"
@@ -108,10 +149,12 @@ references:
         given-names: "Nitish"
         email: "[email protected]"
         affiliation: "Alliander"
+        orcid: "https://orcid.org/0009-0007-9694-6077"
       - family-names: "Govers"
-        given-names: "Martinus"
+        given-names: "Martinus G.H."
         email: "[email protected]"
         affiliation: "Alliander"
+        orcid: "https://orcid.org/0009-0008-6890-8353"
       - family-names: "Bogaard"
         name-particle: "van den"
         given-names: "Jonas"
@@ -123,9 +166,15 @@ references:
         given-names: "Zhen"
         email: "[email protected]"
         affiliation: "Alliander"
+        orcid: "https://orcid.org/0000-0003-4317-6455"
       - family-names: "Guo"
-        given-names: "Jerry"
-        email: "[email protected]"
+        given-names: "Jerry Jinfeng"
+        email: "[email protected]"
+        affiliation: "Alliander"
+        orcid: "https://orcid.org/0000-0002-8065-4084"
+      - family-names: "Figueroa Manrique"
+        given-names: "Santiago"
+        email: "[email protected]"
         affiliation: "Alliander"
       - family-names: "Jagutis"
         given-names: "Laurynas"
@@ -135,8 +184,4 @@ references:
         given-names: "Chenguang"
         email: "[email protected]"
         affiliation: "Alliander"
-      - family-names: "Figueroa Manrique"
-        given-names: "Santiago"
-        email: "[email protected]"
-        affiliation: "Alliander" 
       - name: "Contributors to the LF Energy project Power Grid Model"
diff --git a/README.md b/README.md
@@ -100,20 +100,22 @@ If you are using Power Grid Model in your research work, please consider citing
 
 ```bibtex
 @software{Xiang_PowerGridModel_power-grid-model,
-  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry and Jagutis, Laurynas and Wang, Chenguang and van Raalte, Marc and {Contributors to the LF Energy project Power Grid Model}},
+  author = {Xiang, Yu and Salemink, Peter and van Westering, Werner and Bharambe, Nitish and Govers, Martinus G.H. and van den Bogaard, Jonas and Stoeller, Bram and Wang, Zhen and Guo, Jerry Jinfeng and Figueroa Manrique, Santiago and Jagutis, Laurynas and Wang, Chenguang and van Raalte, Marc and {Contributors to the LF Energy project Power Grid Model}},
   doi = {10.5281/zenodo.8054429},
   license = {MPL-2.0},
   title = {{PowerGridModel/power-grid-model}},
   url = {https://github.com/PowerGridModel/power-grid-model}
 }
 @inproceedings{Xiang2023,
   author = {Xiang, Yu and Salemink, Peter and Stoeller, Bram and Bharambe, Nitish and van Westering, Werner},
-  booktitle = {CIRED 2023 - The 27th International Conference and Exhibition on Electricity Distribution},
-  title = {Power grid model: A high-performance distribution grid calculation library},
-  year = {2023},
+  booktitle={27th International Conference on Electricity Distribution (CIRED 2023)},
+  title={Power grid model: a high-performance distribution grid calculation library},
+  year={2023},
   volume={2023},
-  number = {},
-  pages={1-5}
+  number={},
+  pages={1089-1093},
+  keywords={},
+  doi={10.1049/icp.2023.0633}
 }
 ```
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -43,10 +43,13 @@
     "hoverxref.extension",
     "myst_nb",
     "sphinxcontrib.mermaid",
+    "sphinxcontrib.tikz",
 ]
 
 templates_path = ["_templates"]
 
+tikz_latex_preamble = "\\usepackage{circuitikz}"
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
@@ -55,6 +58,7 @@
 
 exclude_patterns = [
     "*/.ipynb_checkpoints/*",
+    "_build/**/*",
 ]
 
 # -- myst parser and myst_nb config ------------------------------------------------------