-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathoverview.html
283 lines (167 loc) · 10 KB
/
overview.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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Overview — prisms-jobs 4.0.2 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="install.html" />
<link rel="prev" title="Welcome to prisms-jobs’s documentation!" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> prisms-jobs
</a>
<div class="version">
4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">prisms_jobs documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="scripts/index.html">Command line scripts documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="help.html">Getting help</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">prisms-jobs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/overview.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p>When submitted through the <code class="docutils literal notranslate"><span class="pre">prisms_jobs</span></code> Python package or the included scripts,
cluster jobs are stored in a SQLite jobs database. This allows for convenient
monitoring and searching of submitted jobs.</p>
<p>It is often necessary to submit multiple jobs until a particular task is complete,
whether due to walltime or other limitations. <code class="docutils literal notranslate"><span class="pre">prisms-jobs</span></code> distinguishes and
tracks both individual “jobstatus” (‘R’, ‘Q’, ‘C’, ‘E’, etc.) and “taskstatus”.
Jobs marked as ‘auto’ can be automatically or easily resubmitted until the
“taskstatus” is “Complete”.</p>
<p>Possible values for “taskstatus” are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="80%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>“Complete”</td>
<td>Job and task are complete.</td>
</tr>
<tr class="row-even"><td>“Incomplete”</td>
<td>Job or task are incomplete.</td>
</tr>
<tr class="row-odd"><td>“Continued”</td>
<td>Job is complete, but task was not complete.</td>
</tr>
<tr class="row-even"><td>“Check”</td>
<td>Non-auto job is complete and requires user
input for status.</td>
</tr>
<tr class="row-odd"><td>“Error:.*”</td>
<td>Some kind of error was noted.</td>
</tr>
<tr class="row-even"><td>“Aborted”</td>
<td>The job and task have been aborted.</td>
</tr>
</tbody>
</table>
<p>Jobs are marked ‘auto’ either by submitting through the python class <code class="docutils literal notranslate"><span class="pre">prisms_jobs.Job</span></code>
with the attribute <code class="docutils literal notranslate"><span class="pre">auto=True</span></code>, or by submitting a script which contains
the line <code class="docutils literal notranslate"><span class="pre">#auto=True</span></code> using the included <code class="docutils literal notranslate"><span class="pre">psub</span></code> command line program.</p>
<p>Jobs can be monitored using the command line program <code class="docutils literal notranslate"><span class="pre">pstat</span></code>. All ‘auto’ jobs
which have stopped can be resubmitted using <code class="docutils literal notranslate"><span class="pre">pstat</span> <span class="pre">--continue</span></code>. In this case,
‘continuation_jobid’ is set with the jobid for the next job in the series of jobs
comprising a task.</p>
<p>Example screen shot:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pstat
Tracked:
JobID JobName Nodes Procs Walltime S Runtime Task A ContJobID
------------ ------------------------ ----- ----- ------------ - ------------ ------------------------ - ------------
11791024 STDIN 1 1 0:01:00:00 Q - Incomplete 1 -
11791025 STDIN 1 1 0:01:00:00 Q - Incomplete 1 -
Untracked:
JobID JobName Nodes Procs Walltime S Runtime Task A ContJobID
------------ ------------------------ ----- ----- ------------ - ------------ ------------------------ - ------------
11791026 taskmaster 1 1 0:01:00:00 W 0:01:00:00 Untracked 0 -
</pre></div>
</div>
<p>Additionally, when scheduling periodic jobs is not allowed other ways, the
<code class="docutils literal notranslate"><span class="pre">taskmaster</span></code> script can fully automate this process. <code class="docutils literal notranslate"><span class="pre">taskmaster</span></code> executes
<code class="docutils literal notranslate"><span class="pre">pstat</span> <span class="pre">--continue</span></code> and then resubmits itself to execute again periodically. As
not all compute resources allow this behavior, remember check the policy prior
to using <code class="docutils literal notranslate"><span class="pre">taskmaster</span></code> on a new compute resource.</p>
<p>A script marked ‘auto’ should check itself for completion and when reached execute
<code class="docutils literal notranslate"><span class="pre">pstat</span> <span class="pre">--complete</span> <span class="pre">$JOBID</span> <span class="pre">--force</span></code> in bash, or <code class="docutils literal notranslate"><span class="pre">prisms_jobs.complete_job()</span></code>
in Python. If an ‘auto’ job script does not set its taskstatus to “Complete” it
may continue to be resubmitted indefinitely.</p>
<p>Jobs not marked ‘auto’ are shown with the status “Check” in <code class="docutils literal notranslate"><span class="pre">pstat</span></code> until the user
marks them as “Complete”.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="install.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to prisms-jobs’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, PRISMS Center and CASM Developers
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>