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.

Sign up for GitHub

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

Jump to bottom

Updated citation details #1198

Merged
merged 4 commits into from
Apr 24, 2024
Merged

Updated citation details #1198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5783b1e
Update CITATION.cff
mondus Apr 17, 2024
9f1d3bd
Update README.md
mondus Apr 17, 2024
1379968
Update README.md
mondus Apr 23, 2024
ea581cc
passes validation with top level authors list
mondus Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

@ptheywood ptheywood Apr 18, 2024 •
edited
Loading

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

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"

2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Loading