Update CITATION.cff and add Zenodo DOI

Citation updated to cite the repository, with the ICHEP paper as a "preferred-citation". Criterion for repository author is set at the rather arbitrary +1000 lines bar
key4hep · Feb 21, 2025 · 9e5cc42 · 9e5cc42
1 parent 9995e57
commit 9e5cc42
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 27 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -4,8 +4,8 @@
 cff-version: 1.2.0
 title: EDM4hep
 message: >-
-  If you use this software, please cite it using the
-  metadata from this file.
+  If you use this software, please cite both the article
+  from  preferred-citation and the software itself.
 type: software
 authors:
   - given-names: Frank
@@ -18,40 +18,77 @@ authors:
     email: thomas.madlener@desy.de
     affiliation: DESY
     orcid: 'https://orcid.org/0000-0002-0128-6536'
-  - given-names: Placido
-    family-names: Declara Fernandez
-    orcid: 'https://orcid.org/0000-0002-8432-2183'
-  - given-names: Ganis
-    family-names: Gerardo
-    affiliation: CERN
-    email: Gerardo.Ganis@cern.ch
-    orcid: 'https://orcid.org/0000-0002-1175-206X'
-  - given-names: Hegner
-    family-names: Benedikt
-    affiliation: CERN
-    orcid: 'https://orcid.org/0009-0009-2020-1620'
-    email: Benedikt.Hegner@cern.ch
-  - given-names: Clement
-    family-names: Helsens
-    affiliation: CERN
-    orcid: 'https://orcid.org/0000-0002-9243-7554'
   - given-names: André Philippe
     family-names: Sailer
     affiliation: CERN
-    orcid: 'https://orcid.org/0000-0002-9897-5214'
     email: andre.philippe.sailer@cern.ch
-  - given-names: Graeme Andrew
-    family-names: Stewart
-    email: graeme.andrew.stewart@cern.ch
-    affiliation: CERN
-    orcid: 'https://orcid.org/0000-0003-0182-7088'
+    orcid: 'https://orcid.org/0000-0002-9897-5214'
   - given-names: Valentin
     family-names: Völkl
     email: valentin.volkl@cern.ch
     affiliation: CERN
     orcid: 'https://orcid.org/0000-0002-9172-6629'
+  - given-names: Carceller
+    family-names: Juan Miguel
+    email: j.m.carcell@cern.ch
+    affiliation: CERN
+    orcid: 'https://orcid.org/0000-0002-2254-1495'
+  - given-names: Fila
+    family-names: Mateusz Jakub
+    email: mateusz.jakub.fila@cern.ch
+    affiliation: CERN
+    orcid: 'https://orcid.org/0000-0003-3917-2371'  
 identifiers:
   - type: doi
-    value: 10.22323/1.414.1237
+    value: 10.5281/zenodo.4785062
 repository-code: 'https://github.com/key4hep/EDM4hep'
 license: Apache-2.0
+preferred-citation:
+  title: EDM4hep - a common event data model for HEP experiments
+  type: article
+  authors:
+    - given-names: Frank
+      family-names: Gaede
+      email: frank.gaede@desy.de
+      affiliation: DESY
+      orcid: 'https://orcid.org/0000-0002-7055-9200'
+    - given-names: Madlener
+      family-names: Thomas
+      email: thomas.madlener@desy.de
+      affiliation: DESY
+      orcid: 'https://orcid.org/0000-0002-0128-6536'
+    - given-names: Placido
+      family-names: Declara Fernandez
+      orcid: 'https://orcid.org/0000-0002-8432-2183'
+    - given-names: Ganis
+      family-names: Gerardo
+      affiliation: CERN
+      email: Gerardo.Ganis@cern.ch
+      orcid: 'https://orcid.org/0000-0002-1175-206X'
+    - given-names: Hegner
+      family-names: Benedikt
+      affiliation: CERN
+      orcid: 'https://orcid.org/0009-0009-2020-1620'
+      email: Benedikt.Hegner@cern.ch
+    - given-names: Clement
+      family-names: Helsens
+      affiliation: CERN
+      orcid: 'https://orcid.org/0000-0002-9243-7554'
+    - given-names: André Philippe
+      family-names: Sailer
+      affiliation: CERN
+      orcid: 'https://orcid.org/0000-0002-9897-5214'
+      email: andre.philippe.sailer@cern.ch
+    - given-names: Graeme Andrew
+      family-names: Stewart
+      email: graeme.andrew.stewart@cern.ch
+      affiliation: CERN
+      orcid: 'https://orcid.org/0000-0003-0182-7088'
+    - given-names: Valentin
+      family-names: Völkl
+      email: valentin.volkl@cern.ch
+      affiliation: CERN
+      orcid: 'https://orcid.org/0000-0002-9172-6629'
+  identifiers:
+    - type: doi
+      value: 10.22323/1.414.1237
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 
 [![key4hep](https://github.com/key4hep/EDM4hep/workflows/key4hep_linux/badge.svg)](https://github.com/key4hep/EDM4hep/actions/workflows/key4hep_linux.yml)
 [![linux](https://github.com/key4hep/EDM4hep/actions/workflows/lcg_linux_with_podio.yml/badge.svg)](https://github.com/key4hep/EDM4hep/actions/workflows/lcg_linux_with_podio.yml)
-# EDM4hep
+[![DOI](https://zenodo.org/badge/209480664.svg)](https://zenodo.org/doi/10.5281/zenodo.4785062)
 
+# EDM4hep
 
 A generic event data model for future HEP collider experiments.