Skip to content

clarify citation info in doc #327

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

Merged
apcraig merged 3 commits into from
Jul 15, 2020
Merged

clarify citation info in doc #327

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1681fe
clarify citation info in doc
eclare108213 Jul 13, 2020
8c3af4c
minor edit
eclare108213 Jul 13, 2020
03f1ce3
address @phil-blain comments
eclare108213 Jul 13, 2020
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
27 changes: 20 additions & 7 deletions doc/source/intro/citing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,27 @@
Citing the Icepack code
=======================

If you use the Icepack code, please cite the version you are using
with the Icepack Digital Object Identifier (DOI):
Each individual release has its own Digital Object Identifier (DOI),
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 (https://zenodo.org/record/1213462). This DOI
represents all v1 releases, and will always resolve to the latest one.
More information can be found by following the DOI link to zenodo.

DOI:10.5281/zenodo.1213462 (https://zenodo.org/record/1213462)

This DOI can be used to cite all Icepack versions and the URL will default to the most recent version.
However, each released version of Icepack will also receive its own, unique DOI that can be
used for citations as well.
If you use Icepack, please cite the version number of the code you
are using or modifying.

Please also make the CICE Consortium aware of any publications and model use.
If using code from the repository master that includes modifications
Comment thread
eclare108213 marked this conversation as resolved.
Outdated
that have not yet been released with a version number, then in
addition to the most recent version number, the hash at time of
download can be cited, determined by executing the command ‘git log’
Comment thread
eclare108213 marked this conversation as resolved.
Outdated
in your clone. The last 7 digits are generally sufficient to identify
the latest commit.
Comment thread
eclare108213 marked this conversation as resolved.
Outdated

A hash can also be cited for your own modifications, once they have
been committed to a repository branch.

Please also make the CICE Consortium aware of any publications and
model use.