Merge pull request #210 from PowerGridModel/feature/citations-readthe…

…docs Feature/citations readthedocs
PowerGridModel · Dec 15, 2023 · 714f076 · 714f076
2 parents a412384 + 88dc2c9
commit 714f076
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 8 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -19,8 +19,11 @@ build:
       # download support
       - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/RELEASE.md
       - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SUPPORT.md
+      - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/SECURITY.md
       - wget -P docs/release_and_support https://github.com/PowerGridModel/.github/raw/main/CITATION.md
       # download contribution
       - wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/GOVERNANCE.md
       - wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CONTRIBUTING.md
       - wget -P docs/contribution https://github.com/PowerGridModel/.github/raw/main/CODE_OF_CONDUCT.md
+      # fix links
+      - find docs/release_and_support -name "*.md" -exec sed -i -r "s|./CONTRIBUTING.md|../contribution/CONTRIBUTING.md|g" {} \;
diff --git a/CITATION.cff b/CITATION.cff
@@ -33,6 +33,14 @@ authors:
     affiliation: "Alliander"
   - family-names: "Stoeller"
     given-names: "Bram"
+  - family-names: "Wang"
+    given-names: "Zhen"
+    email: "[email protected]"
+    affiliation: "Alliander"
+  - family-names: "Guo"
+    given-names: "Jerry"
+    email: "[email protected]"
+    affiliation: "Alliander"
   - family-names: "Jagutis"
     given-names: "Laurynas"
     email: "[email protected]"
@@ -41,7 +49,7 @@ authors:
     given-names: "Chenguang"
     email: "[email protected]"
     affiliation: "Alliander"
-  - name: "Contributors from the LF Energy project Power Grid Model"
+  - name: "Contributors to the LF Energy project Power Grid Model"
 contact:
   - name: "LF Energy project Power Grid Model"
     email: "[email protected]"
@@ -55,15 +63,15 @@ references:
     authors:
       - family-names: "Xiang"
         given-names: "Yu"
-        email: [email protected]
+        email: "[email protected]"
         affiliation: "Alliander"
       - family-names: "Salemink"
         given-names: "Peter"
-        email: [email protected]
+        email: "[email protected]"
         affiliation: "Alliander"
       - family-names: "Bharambe"
         given-names: "Nitish"
-        email: [email protected]
+        email: "[email protected]"
         affiliation: "Alliander"
       - family-names: "Govers"
         given-names: "Martinus"
@@ -72,10 +80,18 @@ references:
       - family-names: "Bogaard"
         name-particle: "van den"
         given-names: "Jonas"
-        email: [email protected]
+        email: "[email protected]"
         affiliation: "Alliander"
       - family-names: "Stoeller"
         given-names: "Bram"
+      - family-names: "Wang"
+        given-names: "Zhen"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - family-names: "Guo"
+        given-names: "Jerry"
+        email: "[email protected]"
+        affiliation: "Alliander"
       - family-names: "Jagutis"
         given-names: "Laurynas"
         email: "[email protected]"
@@ -84,7 +100,12 @@ references:
         given-names: "Chenguang"
         email: "[email protected]"
         affiliation: "Alliander"
-      - name: "Contributors from the LF Energy project Power Grid Model"
+      - family-names: "Raalte"
+        name-particle: "van"
+        given-names: "Marc"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - name: "Contributors to the LF Energy project Power Grid Model"
 
   - title: "Power grid model: A high-performance distribution grid calculation library"
     authors:

diff --git a/README.md b/README.md
@@ -69,14 +69,14 @@ If you are using Power Grid Model IO in your research work, please consider citi
 
 ```bibtex
 @software{Xiang_PowerGridModel_power-grid-model-io,
-  author = {Xiang, Yu and Salemink, Peter and Bharambe, Nitish and Govers, Martinus and van den Bogaard, Jonas and Stoeller, Bram and Jagutis, Laurynas and Wang, Chenguang and {Contributors from the LF Energy project 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 {Contributors to the LF Energy project Power Grid Model}},
   doi = {10.5281/zenodo.8059257},
   license = {MPL-2.0},
   title = {{PowerGridModel/power-grid-model-io}},
   url = {https://github.com/PowerGridModel/power-grid-model-io}
 }
 @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 Jagutis, Laurynas and Wang, Chenguang and {Contributors from the LF Energy project 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}},
   doi = {10.5281/zenodo.8054429},
   license = {MPL-2.0},
   title = {{PowerGridModel/power-grid-model}},

diff --git a/docs/index.md b/docs/index.md
@@ -85,5 +85,6 @@ contribution/GOVERNANCE.md
 :maxdepth: 2
 release_and_support/RELEASE.md
 release_and_support/SUPPORT.md
+release_and_support/SECURITY.md
 release_and_support/CITATION.md
 ```