add citations.cff

.github/workflows/citations.yml

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Validate citation
+
+on:
+  # run pipeline on push event of main branch, or when CITATIONS path has changed
+  push:
+    branches:
+      - main
+    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:
+  group: ${{ github.workflow }}-${{ github.ref }}-citations
+  cancel-in-progress: true
+
+jobs:
+  validate-citations:
+    runs-on: ubuntu-24.04
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+    - name: Install R
+      run: |
+        sudo apt-get update && sudo apt-get install -y r-base
+    - name: Validate CITATION.cff
+      uses: dieghernan/cff-validator@v4

CITATION.cff

@@ -0,0 +1,173 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+cff-version: 1.2.0
+message: "If you are using Power Grid Model in your research work, please consider citing our library as below."
+
+title: "PowerGridModel/power-grid-model-ds"
+url: "https://github.com/PowerGridModel/power-grid-model-ds"
+license: "MPL-2.0"
+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"
+contact:
+  - name: "LF Energy project Power Grid Model"
+    email: "[email protected]"
+
+references:
+  - title: "PowerGridModel/power-grid-model"
+    url: "https://github.com/PowerGridModel/power-grid-model"
+    doi: "10.5281/zenodo.8054429"
+    license: "MPL-2.0"
+    authors:
+      - family-names: "Xiang"
+        given-names: "Yu"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - 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"
+      - family-names: "Bharambe"
+        given-names: "Nitish"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - family-names: "Govers"
+        given-names: "Martinus"
+        email: "[email protected]"
+        affiliation: "Alliander"
+        orcid: "0009-0008-6890-8353"
+      - family-names: "Bogaard"
+        name-particle: "van den"
+        given-names: "Jonas"
+        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]"
+        affiliation: "Alliander"
+      - family-names: "Wang"
+        given-names: "Chenguang"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - family-names: "Raalte"
+        name-particle: "van"
+        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"
+
+  - 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"
+      - family-names: "Salemink"
+        given-names: "Peter"
+        email: [email protected]
+        affiliation: "Alliander"
+      - family-names: "Stoeller"
+        given-names: "Bram"
+      - family-names: "Bharambe"
+        given-names: "Nitish"
+        email: [email protected]
+        affiliation: "Alliander"
+      - family-names: "Westering"
+        name-particle: "van"
+        given-names: "Werner"
+        email: [email protected]
+        affiliation: "Alliander"
+    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-io"
+    repository-code: "https://github.com/PowerGridModel/power-grid-model-io"
+    doi: "10.5281/zenodo.8059257"
+    license: "MPL-2.0"
+    type: software-code
+    authors:
+      - family-names: "Xiang"
+        given-names: "Yu"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - family-names: "Salemink"
+        given-names: "Peter"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - family-names: "Bharambe"
+        given-names: "Nitish"
+        email: "[email protected]"
+        affiliation: "Alliander"
+      - family-names: "Govers"
+        given-names: "Martinus"
+        email: "[email protected]"
+        affiliation: "Alliander"
+        orcid: "0009-0008-6890-8353"
+      - family-names: "Bogaard"
+        name-particle: "van den"
+        given-names: "Jonas"
+        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]"
+        affiliation: "Alliander"
+      - family-names: "Wang"
+        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"