feat: add CITATION.cff #1994
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| abstract: "EICrecon is the EIC online/offline reconstruction software." | ||
| authors: # in the order of https://zenodo.org/records/15880663/export/cff | ||
| - given-names: The ePIC Collaboration | ||
| - family-names: Wouter Deconinck | ||
| - family-names: David Lawrence | ||
| - family-names: Dmitry Romanov | ||
| - family-names: Dmitry Kalinkin | ||
| - family-names: Christopher Dilks | ||
| - family-names: Thomas Britton | ||
| - family-names: Simon Gardner | ||
| - family-names: Tooba Ali | ||
| - family-names: Nathan Brei | ||
| - family-names: Xinxin (Cissie) Mei | ||
| - family-names: Derek M Anderson | ||
| - family-names: Barak Schmookler | ||
| - family-names: Ryan Milton | ||
| - family-names: Sebouh Paul | ||
| - family-names: Alex Jentsch | ||
| - family-names: John Lajoie | ||
| - family-names: Sakib Rahman | ||
| - family-names: Joseph (Joe) Osborn | ||
| - family-names: Shyam Kumar | ||
| - family-names: Tommy Chun Yuen Tsang | ||
| - family-names: Zhongling Ji | ||
| - family-names: Matt Posik | ||
| - family-names: Peter Steinberg | ||
| - family-names: Minho Kim | ||
| - family-names: Daniel Brandenburg | ||
| - family-names: Dhevan Gangadharan | ||
| cff-version: 1.2.0 | ||
| date-released: '<replace with the actual release date>' | ||
|
Contributor
Author
There was a problem hiding this comment. The intention behind this was to avoid people just including a reference without any version at all. If we put a real version here, then it would just go out of sync.
Member
There was a problem hiding this comment. I assume if we omit, Zenodo will fill this in? Looking at https://github.com/scikit-hep/uproot5/blob/main/CITATION.cff Each version on Zeonodo is already provided with an unique DOI, we don't need to make a CITATION.cff to address that.
Contributor
Author
There was a problem hiding this comment. My concern is that people won't (only) go to zenodo for the citation, but copy it directly from GitHub, see https://github.com/eic/epic/ and the "Cite this repository" menu on the right sidebar. That's based purely on what's inside the cff file.
Member
There was a problem hiding this comment. So we should be removing the cff file from eic/epic and replacing it with a Zenodo link in the README?
Contributor
Author
There was a problem hiding this comment. That's what we have here... and it isn't working. I think having the "Cite this repository" is a better solution than expecting people to know they can cite zenodo. They (especially now) think of zenodo as a place for internal documents. |
||
| doi: 10.5281/zenodo.15880663 | ||
| identifiers: | ||
| - type: swh | ||
| value: swh:1:dir:75196c46ce549dded398985e500dafcf6a1e5f7c;origin=https://doi.org/10.5281/zenodo.7942531;visit=swh:1:snp:eeac3d121922af83467c6081ca862b631acd15d7;anchor=swh:1:rel:166eaec6e708067946596cfa344c95189ce99608;path=eic-EICrecon-7fad7b7 | ||
| license: | ||
| - lgpl-3.0-only | ||
| message: If you use this software, please cite it using the metadata from this file. | ||
| repository-code: https://github.com/eic/EICrecon | ||
| title: 'eic/EICrecon: <replace with the actual version>' | ||
| type: software | ||
| version: '<replace with the actual version>' | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do we keep this up to date?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was wondering about that too. It's related to the problem with the versions. If we could automate our version release workflow and include a download of a new CITATION.cff, then we can get away from this. Otherwise, I am just tempted to keep it as is, and replace it maybe on demand (we can add a comment line to the file) or on schedule. We could probably even do a scheduled job that downloads the file, checks for diffs, and opens a PR with the necessary changes. But that's all work...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess, the assumption here, again, that we somehow track this better then Zenodo can. I don't quite understand how a job would source some better information (parse spdx headers?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're overthinking the job. It would consist of
curl https://zenodo.org/records/15880663/export/cffwith some massaging :-)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's until Zenodo will start feeding you your own cff?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Putting the curl in curl.