Add CITATION.cff file with citation information (#266)

* Add CITATION.cff file with citation information

* Update CITATION.cff with current version

Add a step to update the CITATION.cff file with the current version.

* Update version comment in CITATION.cff

---------

Co-authored-by: Lukas Trippe <lkstrp@pm.me>

Author: euronion

.github/workflows/release.yml

@@ -89,6 +89,23 @@ jobs:
         fig.savefig('doc/powerplants.png')
       shell: python
 
+    - name: Update CITATION.cff
+      run: |
+        import re
+        from setuptools_scm import get_version
+
+        version = get_version()
+
+        with open('CITATION.cff', 'r') as file:
+          cff_content = file.read()
+        cff_content = open('CITATION.cff', 'r').read()
+
+        updated_cff_content = re.sub(r"(?<=version: ).+(?= #)",version,cff_content,flags=re.MULTILINE)
+
+        with open('CITATION.cff', 'w') as file:
+          file.write(updated_cff_content)
+      shell: python
+
     # End of preparation script
 
     - name: Remove previous tag

CITATION.cff

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: Contributors to powerplantmatching <https://github.com/pypsa/powerplantmatching>
+#
+# SPDX-License-Identifier: MIT
+
+cff-version: 1.2.0
+message: "If you use this package, please cite the corresponding manuscript in Journal of Open Research Software."
+title: "Performing energy modelling exercises in a transparent way - The issue of data quality in power plant databases"
+journal: Energy Strategy Reviews
+doi: 10.1016/j.esr.2018.11.004
+repository: https://github.com/pypsa/powerplantmatching
+version: 0.7.1 # Don't touch, will be updated by the release script
+license: MIT
+authors:
+  - family-names: Gotzens
+    given-names: Fabian
+    orcid: https://orcid.org/0000-0001-8546-2033
+  - family-names: Heinrichs
+    given-names: Heidi
+    orcid: https://orcid.org/0000-0001-9536-9465
+  - family-names: Hörsch
+    given-names: Jonas
+    orcid: https://orcid.org/0000-0001-9438-767X
+  - family-names: Hofmann
+    given-names: Fabian
+    orcid: https://orcid.org/0000-0002-6604-5450