Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated citation details #1198

Merged
merged 4 commits into from
Apr 24, 2024
Merged

Updated citation details #1198

merged 4 commits into from
Apr 24, 2024

Conversation

mondus
Copy link
Member

@mondus mondus commented Apr 17, 2024

Closes #1064

  • Adds preferred citation to CITATION.cff files
  • Update to the readme to clarify when to use citation of the article or the software itself.

Added preferred-citation
Updated readme with citation details
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:
Copy link
Member

@ptheywood ptheywood Apr 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a valid citation.cff file

jsonschema.exceptions.ValidationError: 'authors' is a required property

See the citation-file-format readme on how to validate citation.cff files

https://github.com/citation-file-format/citation-file-format?tab=readme-ov-file#validation-heavy_check_mark

I.e. there needs to be a top-level authors key still for the authors of the software, which may be different to the authors of the preferred citation, as shown in the credit redirection section of the cff docs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have added the top level authors and checked validation

README.md Outdated Show resolved Hide resolved
mondus and others added 2 commits April 23, 2024 11:22
Co-authored-by: Peter Heywood <p.heywood@sheffield.ac.uk>
@mondus mondus requested a review from ptheywood April 24, 2024 12:47
@ptheywood ptheywood merged commit b5173e7 into master Apr 24, 2024
20 checks passed
@ptheywood ptheywood deleted the citation branch April 24, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add FLAME GPU 2 publication to Readme and / or citation.cff
2 participants