Merge pull request #1316 from Ly0n/add-CITATION-cff

Add CITATION.cff and DOI badge

CITATION.cff

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText:  PyPSA-Earth and PyPSA-Eur Authors
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+title: PyPSA-Earth. A new global open energy system optimization model demonstrated in Africa
+abstract: This repository contains the source code of the paper PyPSA-Earth. A new global open energy system optimization model demonstrated in Africa by Maximilian Parzen, Hazem Abdel-Khalek, Ekaterina Fedotova, Matin Mahmood, Martha Maria Frysztacki, Johannes Hampp, Lukas Franken, Leon Schumm, Fabian Neumann, Davide Poli, Aristides Kiprakis and Davide Fioriti, from Applied Energy
+doi: 10.1016/j.apenergy.2023.121096
+repository-code: https://github.com/pypsa-meets-earth/pypsa-earth
+version: 1.0.0
+date-released: 2023-04-18
+message: If you use this software in your work, please cite it using the following metadata.
+authors:
+  - given-names: Maximilian
+    family-names: Parzen
+    orcid: https://orcid.org/0000-0002-4390-0063
+  - given-names: Hazem
+    family-names: Abdel-Khalek
+  - given-names: Ekaterina
+    family-names: Fedotova
+    orcid: https://orcid.org/0000-0002-5590-9591
+  - given-names: Matin
+    family-names: Mahmood
+  - given-names: Martha Maria
+    family-names: Frysztacki
+    orcid: https://orcid.org/0000-0002-0788-1328
+  - given-names: Johannes
+    family-names: Hampp
+    orcid: https://orcid.org/0000-0002-1776-116X
+  - given-names: Lukas
+    family-names: Franken
+  - given-names: Leon
+    family-names: Schumm
+  - given-names: Fabian
+    family-names: Neumann
+    orcid: https://orcid.org/0000-0002-6604-5450
+  - given-names: Davide
+    family-names: Poli
+    orcid: https://orcid.org/0000-0002-5045-9034
+  - given-names: Aristides
+    family-names: Kiprakis
+  - given-names: Davide
+    family-names: Fioriti
+    orcid: https://orcid.org/0000-0001-5491-7912
+cff-version: 1.2.0

README.md

@@ -24,6 +24,8 @@ by
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pypsa-meets-earth/pypsa-earth/main.svg)](https://results.pre-commit.ci/latest/github/pypsa-meets-earth/pypsa-earth/main)
 [![Discord](https://img.shields.io/discord/911692131440148490?logo=discord)](https://discord.gg/AnuJBk23FU)
 [![Google Drive](https://img.shields.io/badge/Google%20Drive-4285F4?style=flat&logo=googledrive&logoColor=white)](https://drive.google.com/drive/folders/13Z8Y9zgsh5IZaDNkkRyo1wkoMgbdUxT5?usp=sharing)
+[![DOI](https://img.shields.io/badge/DOI-10.1016%2Fj.apenergy.2023.121096-blue)](https://doi.org/10.1016/j.apenergy.2023.121096)
+
 
 **PyPSA-Earth: A Global Sector-Coupled Open-Source Multi-Energy System Model**
 

doc/release_notes.rst

@@ -37,6 +37,8 @@ This part of documentation collects descriptive release notes to capture the mai
 
 * Fix the need for administrative rights on Windows by changing all shadow directory settings for Windows in the Snakefile `PR #1295 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/1295>`__ and  `PR #1301 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/1301>`__
 
+* Add CITATION.cff to guide users on how cite PyPSA-Earth. Insert the DOI badge in the README linking to the very first PyPSA-Earth paper. `PR #1316 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/1316>`__
+
 PyPSA-Earth 0.6.0
 =================