pism / pism

Repository for the Parallel Ice Sheet Model (PISM)
https://pism.io/
GNU General Public License v3.0
99 stars 41 forks source link

Add citation guidelines to the manual #548

Closed ckhroulev closed 2 months ago

ckhroulev commented 3 months ago

This PR adds citation guidelines to the manual, including information about preserving data needed to aid reproducibility.

The goals are: improve citation guidelines and reduce duplication.

Until now we had some recommendations

plus some seemingly related text in doc/sphinx/acknowledgments.rst.

Now all citation guidelines are in doc/sphinx/citing/index.rst (named this way to be available at www.pism.io/docs/citing once this version of the manual is online).

Checklist

ckhroulev commented 3 months ago

@gassmoeller @ljhwang I added more detailed PISM citation guidelines and attempted to reduce duplication. Please let me know what you think -- any input is much appreciated. Thanks!

ljhwang commented 3 months ago

This looks very thorough! Thanks.

A few comments:

ckhroulev commented 2 months ago

@ljhwang Thanks for the feedback!

I added a statement reminding users to consider contributing their modifications.

I agree that if one uses a publicly available repository to store the code then a citation should include the short hash of the relevant commit. I am reluctant to recommend this, though: I think it is always better to archive the code and get a DOI, especially since it's easy and free.

PS: Based on the feedback I got from a PISM contributor I split recommendations into two sections: "Citing PISM" and "Publishing" with hyperlinks from one to the other. (Rationale: publishing modeling results involves more than citing PISM and citing PISM may be needed when publishing something else, i.e. not PISM results.)