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

model citation guidance #465

Closed
eclare108213 opened this issue Jun 10, 2020 · 2 comments
Closed

model citation guidance #465

eclare108213 opened this issue Jun 10, 2020 · 2 comments

Comments

@eclare108213
Copy link
Contributor

Clarify wording to use when citing the models (both CICE and Icepack), and describe options for identifying the code used (DOI for series, DOI for particular release, hash for particular commit).

@eclare108213
Copy link
Contributor Author

We already have the basic instructions in the docs:

https://cice-consortium-icepack.readthedocs.io/en/master/intro/citing.html
https://cice-consortium-cice.readthedocs.io/en/master/intro/citing.html

but this sounds a little confusing to me, and it doesn’t mention how to cite codes not yet formally released. Is this better?

(Icepack)
Each individual release has its own DOI number, e.g. Icepack v1.2.2 has DOI 10.5281/zenodo.3888633. All versions of this lineage (e.g. Icepack v1) can be cited by using the DOI 10.5281/zenodo.1213462. This DOI represents all versions, and will always resolve to the latest one. More information can be found by following the DOI links to zenodo.

(CICE)
Each individual release has its own DOI number, e.g. CICE v6.1.2 has DOI 10.5281/zenodo.3888653. All versions of this lineage (e.g. CICE6) can be cited by using the DOI 10.5281/zenodo.1205674. This DOI represents all versions, and will always resolve to the latest one. More information can be found by following the DOI links to zenodo.

(add for both)
If using pre-release code from the repository master, the hash at time of download can be cited, determined by executing the command ‘git log’ in your clone. The last 7 digits are generally sufficient to identify the latest commit.

Note that the version index wikis say “The DOI links include citation instructions.” We should probably point to the docs instead.

@eclare108213
Copy link
Contributor Author

I have submitted two PRs, nearly identical except for code names and version numbers/DOIs.
CICE: #487
Icepack: #327

@apcraig apcraig closed this as completed Jul 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants