Publishing¶

If you use PISM or model outputs from an earlier PISM application in your publication then we ask for an acknowledgment of funding (see Funding acknowledgment) and a citation. Please see Citing PISM for details.

Receiving citations for PISM is important to demonstrate the relevance of our work to our funding agencies and is a matter of fairness to everyone who contributed to its development.[1]

We do not expect co-authorship on papers using PISM unless PISM developers are involved in the preparation of a publication at the usual co-author level.

Note

We maintain a list of PISM applications at pism.io/publications. Please send an e-mail to uaf-pism@alaska.edu to let us know about your work!

See the publishing guidelines from Computational Infrastructure for Geodynamics (CIG) for more recommendations.

Funding acknowledgment¶

Please include this statement to acknowledge PISM’s funding:

Development of PISM is supported by NASA grants 20-CRYO2020-0052 and 80NSSC22K0274 and NSF grant OAC-2118285.

Open research¶

We encourage you to make code and data used in your study publicly available to simplify reproducing your results and provide sufficient information to reviewers to evaluate the publication.

Code availability¶

If you used a released PISM version without modifications it is sufficient to cite the specific PISM version you used.

If you used a development version of PISM (even if you did not make any modifications), please archive and cite it as if it is a customized PISM version.

Example statement

We use PISM version 2.1, which is available under the GPL license from Zenodo [cite the appropriate Zenodo record].

Studies using customized versions of PISM¶

We strongly encourage you to archive your code using a research data repository (e.g. Zenodo) and obtain a DOI for the resulting record. Please make sure to cite this record and the specific PISM version your work is based on.

Example statement

We use a modified version of PISM version 2.1 [cite PISM 2.1] which is available under the GPL license from <Research data repository name> [citation for the corresponding record].

Uploading the code to a public repository (e.g. on GitHub) and providing a URL in a publication is not sufficient: repository contents may change, a repository may be deleted, or a company hosting it may stop providing this service.

Note

Please consider contributing your modifications to PISM’s repository! See Contributing to PISM for details.

Data availability¶

We recommend archiving

all input files necessary to reproduce your research,
all pre-processing scripts that were used to prepare model inputs,
shell scripts and configuration files needed to run PISM,
PISM outputs resulting from simulations you performed,
any output files that can be used to verify that the reproduction of results was successful,
post-processing, analysis and plotting scripts used in preparation of a publication,
a list of required pre-processing, post-processing and analysis tools, including their versions

and then citing the corresponding record using its DOI.

Sometimes an input data set is not publicly available and cannot be archived this way. If possible, please explain how to request access to it (e.g. “please contact Author X et al to request access”).

If model outputs are prohibitively large (e.g. if you ran an ensemble of thousands of high-resolution simulations), please select and archive a subset of outputs that can be used as a “standard.” A person attempting to reproduce your study can then attempt to reproduce these outputs to verify their model setup.

Example statement

The PISM code, model inputs and outputs, the scripts used to run simulations, analyze results and create figures are available at https://doi.org/<insert DOI> (cite the DOI you obtained).

Caution

Each PISM output file includes the PISM version, versions of major PISM dependencies and values of all configuration parameters that were used. Please ensure that this information is not stripped from archived files during post-processing.

Footnotes