Updated citation details (#1198)

* Update CITATION.cff Added preferred-citation * Update README.md Updated readme with citation details --------- Co-authored-by: Peter Heywood <[email protected]>
FLAMEGPU · Apr 24, 2024 · b5173e7 · b5173e7
1 parent fa07fa9
commit b5173e7
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 3 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -33,9 +33,38 @@ authors:
     family-names: Kabiri Chimeh
     alias: mozhgan-kch 
     orcid: "https://orcid.org/0000-0002-2561-7926"
-message: "If you use this software, please cite it using these metadata."
+message: "If you use this software, please cite both the article from preferred-citation and the software itself."
+preferred-citation:
+  authors: 
+    - given-names: Paul
+      family-names: Richmond
+      affiliation: The University of Sheffield
+      alias: mondus
+      orcid: "https://orcid.org/0000-0002-4657-5518"
+    - given-names: Robert
+      family-names: Chisholm
+      affiliation: The University of Sheffield
+      alias: Robadob
+      orcid: "https://orcid.org/0000-0003-3379-9042"
+    - given-names: Peter
+      family-names: Heywood
+      affiliation: The University of Sheffield
+      alias: ptheywood
+      orcid: "https://orcid.org/0000-0001-9277-8394"
+    - given-names: Matthew
+      family-names: Leach
+      affiliation: The University of Sheffield
+      alias: MILeach
+      orcid: "https://orcid.org/0000-0002-8901-5609"
+    - given-names: Mozhgan
+      family-names: Kabiri Chimeh
+      affiliation: NVIDIA
+      alias: mozhgan-kch 
+      orcid: "https://orcid.org/0000-0002-2561-7926"
+  title: "FLAME GPU 2: A framework for flexible and performant agent based simulation on GPUs"
+  type: article
+  doi: 10.1002/spe.3207
 identifiers:
   - description: The collection of archived snapshots of all versions of FLAME GPU 2
     type: doi
     value: "10.5281/zenodo.5428984"
-
diff --git a/README.md b/README.md
@@ -352,7 +352,7 @@ See [CONTRIBUTING.md](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/CONTRIBU
 
 See [Contributors](https://github.com/FLAMEGPU/FLAMEGPU2/graphs/contributors) for a list of contributors towards this project.
 
-If you use this software in your work, please cite DOI [10.5281/zenodo.5428984](https://doi.org/10.5281/zenodo.5428984). Release specific DOI are also provided via Zenodo.
+If you refer to the technical, algorithmic or performance aspects of FLAME GPU then please cite ["FLAME GPU 2: A framework for flexible and performant agent based simulation on GPUs"](https://onlinelibrary.wiley.com/doi/full/10.1002/spe.3207) (DOI: https://doi.org/10.1002/spe.3207). If you use this software in your work, please cite DOI [10.5281/zenodo.5428984](https://doi.org/10.5281/zenodo.5428984). Release specific DOI are also provided via Zenodo.
 
 Alternatively, [CITATION.cff](https://github.com/FLAMEGPU/FLAMEGPU2/blob/master/CITATION.cff) provides citation metadata, which can also be accessed from [GitHub](https://github.com/FLAMEGPU/FLAMEGPU2).