From 00a7d2dcc4b8732efd1bf46d9915fc94b1c338e9 Mon Sep 17 00:00:00 2001 From: Martijn Govers Date: Fri, 31 Jan 2025 09:16:49 +0100 Subject: [PATCH] add citations.cff (#24) * add citations.cff Signed-off-by: Martijn Govers * minor fix Signed-off-by: Martijn Govers * fix orcid Signed-off-by: Martijn Govers --------- Signed-off-by: Martijn Govers --- .github/workflows/citations.yml | 38 +++++++ CITATION.cff | 174 ++++++++++++++++++++++++++++++++ 2 files changed, 212 insertions(+) create mode 100644 .github/workflows/citations.yml create mode 100644 CITATION.cff diff --git a/.github/workflows/citations.yml b/.github/workflows/citations.yml new file mode 100644 index 0000000..99e41cd --- /dev/null +++ b/.github/workflows/citations.yml @@ -0,0 +1,38 @@ +# SPDX-FileCopyrightText: Contributors to the Power Grid Model project +# +# 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 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..1c90d8c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,174 @@ +# SPDX-FileCopyrightText: Contributors to the Power Grid Model project +# +# 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: Jaap.Schouten@Alliander.com + affiliation: "Alliander" + - family-names: "Baaijen" + given-names: "Thijs" + email: Thijs.Baaijen@Alliander.com + affiliation: "Alliander" + - family-names: "Koppen" + given-names: "Vincent" + email: Vincent.Koppen@Alliander.com + - family-names: "Voort" + name-particle: "van der" + given-names: "Sven" + email: Sven.van.der.Voort@Alliander.com + - name: "Contributors to the LF Energy project Power Grid Model" +contact: + - name: "LF Energy project Power Grid Model" + email: "powergridmodel@lists.lfenergy.org" + +references: + - title: "PowerGridModel/power-grid-model" + repository-code: "https://github.com/PowerGridModel/power-grid-model" + doi: "10.5281/zenodo.8054429" + license: "MPL-2.0" + type: software-code + authors: + - family-names: "Xiang" + given-names: "Yu" + email: "Tony.Xiang@Alliander.com" + affiliation: "Alliander" + - family-names: "Salemink" + given-names: "Peter" + email: "Peter.Salemink@Alliander.com" + affiliation: "Alliander" + - family-names: "Westering" + name-particle: "van" + given-names: "Werner" + email: Werner.van.Westering@Alliander.com + affiliation: "Alliander" + - family-names: "Bharambe" + given-names: "Nitish" + email: "Nitish.Bharambe@Alliander.com" + affiliation: "Alliander" + - family-names: "Govers" + given-names: "Martinus" + email: "Martijn.Govers@Alliander.com" + affiliation: "Alliander" + orcid: "https://orcid.org/0009-0008-6890-8353" + - family-names: "Bogaard" + name-particle: "van den" + given-names: "Jonas" + email: "Jonas.van.den.Bogaard@Alliander.com" + affiliation: "Alliander" + - family-names: "Stoeller" + given-names: "Bram" + - family-names: "Wang" + given-names: "Zhen" + email: "Zhen.Wang@Alliander.com" + affiliation: "Alliander" + - family-names: "Guo" + given-names: "Jerry" + email: "Jerry.Jinfeng.Guo@Alliander.com" + affiliation: "Alliander" + - family-names: "Jagutis" + given-names: "Laurynas" + email: "Laurynas.Jagutis@Alliander.com" + affiliation: "Alliander" + - family-names: "Wang" + given-names: "Chenguang" + email: "Chenguang.Wang@Alliander.com" + affiliation: "Alliander" + - family-names: "Raalte" + name-particle: "van" + given-names: "Marc" + email: "Marc.van.Raalte@Alliander.com" + affiliation: "Alliander" + - family-names: "Figueroa Manrique" + given-names: "Santiago" + email: "Santiago.Figueroa.Manrique@Alliander.com" + 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: Tony.Xiang@Alliander.com + affiliation: "Alliander" + - family-names: "Salemink" + given-names: "Peter" + email: Peter.Salemink@Alliander.com + affiliation: "Alliander" + - family-names: "Stoeller" + given-names: "Bram" + - family-names: "Bharambe" + given-names: "Nitish" + email: Nitish.Bharambe@Alliander.com + affiliation: "Alliander" + - family-names: "Westering" + name-particle: "van" + given-names: "Werner" + email: Werner.van.Westering@Alliander.com + 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: "Tony.Xiang@Alliander.com" + affiliation: "Alliander" + - family-names: "Salemink" + given-names: "Peter" + email: "Peter.Salemink@Alliander.com" + affiliation: "Alliander" + - family-names: "Bharambe" + given-names: "Nitish" + email: "Nitish.Bharambe@Alliander.com" + affiliation: "Alliander" + - family-names: "Govers" + given-names: "Martinus" + email: "Martijn.Govers@Alliander.com" + affiliation: "Alliander" + orcid: "https://orcid.org/0009-0008-6890-8353" + - family-names: "Bogaard" + name-particle: "van den" + given-names: "Jonas" + email: "Jonas.van.den.Bogaard@Alliander.com" + affiliation: "Alliander" + - family-names: "Stoeller" + given-names: "Bram" + - family-names: "Wang" + given-names: "Zhen" + email: "Zhen.Wang@Alliander.com" + affiliation: "Alliander" + - family-names: "Guo" + given-names: "Jerry" + email: "Jerry.Jinfeng.Guo@Alliander.com" + affiliation: "Alliander" + - family-names: "Jagutis" + given-names: "Laurynas" + email: "Laurynas.Jagutis@Alliander.com" + affiliation: "Alliander" + - family-names: "Wang" + given-names: "Chenguang" + email: "Chenguang.Wang@Alliander.com" + affiliation: "Alliander" + - family-names: "Figueroa Manrique" + given-names: "Santiago" + email: "Santiago.Figueroa.Manrique@Alliander.com" + affiliation: "Alliander" + - name: "Contributors to the LF Energy project Power Grid Model"