-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpublishing.html
214 lines (191 loc) · 11.9 KB
/
publishing.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Publishing — PISM, a Parallel Ice Sheet Model 2.2.2-d6b3a29ca committed by Constantine Khrulev on 2025-03-28 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=9641f709" />
<script src="_static/documentation_options.js?v=cdb1caaa"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="References" href="zzz_references_html.html" />
<link rel="prev" title="Citing PISM" href="citing/index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="publishing">
<span id="sec-publishing"></span><h1>Publishing<a class="headerlink" href="#publishing" title="Link to this heading">¶</a></h1>
<p>If you use PISM or model outputs from an earlier PISM application in your publication then
we ask for an acknowledgment of funding (see <a class="reference internal" href="#sec-funding-acknowledgment"><span class="std std-ref">Funding acknowledgment</span></a>) and a
citation. Please see <a class="reference internal" href="citing/index.html#sec-citing-pism"><span class="std std-ref">Citing PISM</span></a> for details.</p>
<p>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.<a class="footnote-reference brackets" href="#f1" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p>
<p>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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>We maintain a list of PISM applications at <a class="reference external" href="https://www.pism.io/publications">pism.io/publications</a>. Please send an e-mail to <a class="reference external" href="mailto:uaf-pism%40alaska.edu">uaf-pism<span>@</span>alaska<span>.</span>edu</a> to let us
know about your work!</p>
</div>
<p>See the <a class="reference external" href="https://geodynamics.org/software/software-bp/software-publishing">publishing guidelines</a> from Computational
Infrastructure for Geodynamics (CIG) for more recommendations.</p>
<section id="funding-acknowledgment">
<span id="sec-funding-acknowledgment"></span><h2>Funding acknowledgment<a class="headerlink" href="#funding-acknowledgment" title="Link to this heading">¶</a></h2>
<p>Please include this statement to acknowledge PISM’s funding:</p>
<blockquote>
<div><p>Development of PISM is supported by NASA grants 20-CRYO2020-0052 and 80NSSC22K0274 and NSF grant OAC-2118285.</p>
</div></blockquote>
</section>
<section id="open-research">
<h2>Open research<a class="headerlink" href="#open-research" title="Link to this heading">¶</a></h2>
<p>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.</p>
<section id="code-availability">
<span id="sec-code-availability"></span><h3>Code availability<a class="headerlink" href="#code-availability" title="Link to this heading">¶</a></h3>
<p>If you used a released PISM version <em>without modifications</em> it is sufficient to <a class="reference internal" href="citing/index.html#sec-citing-pism"><span class="std std-ref">cite
the specific PISM version</span></a> you used.</p>
<p>If you used a <em>development</em> version of PISM (even if you did not make any modifications),
please archive and cite it as if it is a <a class="reference internal" href="#sec-citing-customized-pism"><span class="std std-ref">customized PISM version</span></a>.</p>
<div class="admonition-example-statement admonition">
<p class="admonition-title">Example statement</p>
<p>We use PISM version 2.1, which is available under the GPL license from Zenodo
[cite the appropriate Zenodo record].</p>
</div>
<section id="studies-using-customized-versions-of-pism">
<span id="sec-citing-customized-pism"></span><h4>Studies using customized versions of PISM<a class="headerlink" href="#studies-using-customized-versions-of-pism" title="Link to this heading">¶</a></h4>
<p>We strongly encourage you to archive your code using a research data repository (e.g.
<a class="reference external" href="https://zenodo.org/">Zenodo</a>) and obtain a DOI for the resulting record. Please make sure to cite this record
<strong>and</strong> the specific PISM version your work is based on.</p>
<div class="admonition-example-statement admonition">
<p class="admonition-title">Example statement</p>
<p>We use a modified version of PISM version 2.1 [cite PISM 2.1] which is available under
the GPL license from <code class="docutils literal notranslate"><span class="pre"><Research</span> <span class="pre">data</span> <span class="pre">repository</span> <span class="pre">name></span></code> [citation for the
corresponding record].</p>
</div>
<p>Uploading the code to a public repository (e.g. on <a class="reference external" href="https://github.com/">GitHub</a>) 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.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Please consider contributing your modifications to PISM’s repository! See
<a class="reference internal" href="contributing/index.html#sec-contributing"><span class="std std-ref">Contributing to PISM</span></a> for details.</p>
</div>
</section>
</section>
<section id="data-availability">
<span id="sec-data-availability"></span><h3>Data availability<a class="headerlink" href="#data-availability" title="Link to this heading">¶</a></h3>
<p>We recommend archiving</p>
<ul class="simple">
<li><p>all input files necessary to reproduce your research,</p></li>
<li><p>all pre-processing scripts that were used to prepare model inputs,</p></li>
<li><p>shell scripts and configuration files needed to run PISM,</p></li>
<li><p>PISM outputs resulting from simulations you performed,</p></li>
<li><p>any output files that can be used to verify that the reproduction of results was
successful,</p></li>
<li><p>post-processing, analysis and plotting scripts used in preparation of a publication,</p></li>
<li><p>a list of required pre-processing, post-processing and analysis tools, including their
versions</p></li>
</ul>
<p>and then citing the corresponding record using its DOI.</p>
<p>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 <em>Author X et
al</em> to request access”).</p>
<p>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.</p>
<div class="admonition-example-statement admonition">
<p class="admonition-title">Example statement</p>
<p>The PISM code, model inputs and outputs, the scripts used to run simulations, analyze
results and create figures are available at <code class="docutils literal notranslate"><span class="pre">https://doi.org/<insert</span> <span class="pre">DOI></span></code> (cite the
DOI you obtained).</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>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.</p>
</div>
<p class="rubric">Footnotes</p>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="f1" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
<p>See <a class="reference internal" href="authorship.html#sec-pism-authors"><span class="std std-ref">Authorship</span></a> for the list of authors and their contributions.</p>
</aside>
</aside>
</section>
</section>
</section>
<hr>
<table style="width: 100%">
<tr>
<td style="text-align: left; width: 30%">
<a class="reference internal" href="citing/index.html">Previous</a>
</td>
<td style="text-align: center; width: 30%">
</td>
<td style="text-align: right; width: 30%">
<a class="reference internal" href="zzz_references_html.html">Next</a>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/pism-logo.png" alt="Logo"/>
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="acknowledgments.html">Acknowledgments</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installing PISM</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual/index.html">PISM User’s Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="climate_forcing/index.html">Climate forcing</a></li>
<li class="toctree-l1"><a class="reference internal" href="technical/index.html">Technical notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing to PISM</a></li>
<li class="toctree-l1"><a class="reference internal" href="authorship.html">Authorship</a></li>
<li class="toctree-l1"><a class="reference internal" href="citing/index.html">Citing PISM</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Publishing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#funding-acknowledgment">Funding acknowledgment</a></li>
<li class="toctree-l2"><a class="reference internal" href="#open-research">Open research</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#code-availability">Code availability</a></li>
<li class="toctree-l3"><a class="reference internal" href="#data-availability">Data availability</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="zzz_references_html.html">References</a></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
Built using PISM 2.2.2-d6b3a29ca committed by Constantine Khrulev on 2025-03-28 |
© 2004--2025, the PISM authors.
</div>
</body>
</html>