forked from materialsproject/pymatgen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pymatgen.io.abinit.launcher.html
432 lines (383 loc) · 29.7 KB
/
pymatgen.io.abinit.launcher.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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>pymatgen.io.abinit.launcher module — pymatgen 2019.5.1 documentation</title>
<link rel="stylesheet" href="_static/proBlue.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-33990148-1']);
_gaq.push(['_trackPageview']);
</script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pymatgen 2019.5.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pymatgen.io.abinit.launcher">
<span id="pymatgen-io-abinit-launcher-module"></span><h1>pymatgen.io.abinit.launcher module<a class="headerlink" href="#module-pymatgen.io.abinit.launcher" title="Permalink to this headline">¶</a></h1>
<p>Tools for the submission of Tasks.</p>
<dl class="class">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor">
<em class="property">class </em><code class="descname">ScriptEditor</code><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Simple editor that simplifies the writing of shell scripts</p>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.add_comment">
<code class="descname">add_comment</code><span class="sig-paren">(</span><em>comment</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.add_comment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.add_comment" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a comment</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.add_emptyline">
<code class="descname">add_emptyline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.add_emptyline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.add_emptyline" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an empty line.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.add_line">
<code class="descname">add_line</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.add_line"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.add_line" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.add_lines">
<code class="descname">add_lines</code><span class="sig-paren">(</span><em>lines</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.add_lines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.add_lines" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.declare_var">
<code class="descname">declare_var</code><span class="sig-paren">(</span><em>key</em>, <em>val</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.declare_var"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.declare_var" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare a env variable. If val is None the variable is unset.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.declare_vars">
<code class="descname">declare_vars</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.declare_vars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.declare_vars" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare the variables defined in the dictionary d.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.export_envar">
<code class="descname">export_envar</code><span class="sig-paren">(</span><em>key</em>, <em>val</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.export_envar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.export_envar" title="Permalink to this definition">¶</a></dt>
<dd><p>Export an environment variable.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.export_envars">
<code class="descname">export_envars</code><span class="sig-paren">(</span><em>env</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.export_envars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.export_envars" title="Permalink to this definition">¶</a></dt>
<dd><p>Export the environment variables contained in the dict env.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.get_script_str">
<code class="descname">get_script_str</code><span class="sig-paren">(</span><em>reset=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.get_script_str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.get_script_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a string with the script and reset the editor if reset is True</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.load_module">
<code class="descname">load_module</code><span class="sig-paren">(</span><em>module</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.load_module"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.load_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.load_modules">
<code class="descname">load_modules</code><span class="sig-paren">(</span><em>modules</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.load_modules"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.load_modules" title="Permalink to this definition">¶</a></dt>
<dd><p>Load the list of specified modules.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.reset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset the editor.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.shebang">
<code class="descname">shebang</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#ScriptEditor.shebang"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.shebang" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds the shebang line.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.ScriptEditor.shell">
<code class="descname">shell</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.ScriptEditor.shell" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pymatgen.io.abinit.launcher.PyLauncher">
<em class="property">class </em><code class="descname">PyLauncher</code><span class="sig-paren">(</span><em>flow</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyLauncher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyLauncher" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This object handle the submission of the tasks contained in a <code class="xref py py-class docutils literal notranslate"><span class="pre">Flow</span></code></p>
<p>Initialize the object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>flow</strong> – <code class="xref py py-class docutils literal notranslate"><span class="pre">Flow</span></code> object</p></li>
<li><p><strong>max_njobs_inqueue</strong> – The launcher will stop submitting jobs when the
number of jobs in the queue is >= Max number of jobs</p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyLauncher.Error">
<code class="descname">Error</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyLauncher.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">PyLauncherError</span></code></p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyLauncher.fetch_tasks_to_run">
<code class="descname">fetch_tasks_to_run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyLauncher.fetch_tasks_to_run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyLauncher.fetch_tasks_to_run" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of tasks that can be submitted.
Empty list if no task has been found.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyLauncher.rapidfire">
<code class="descname">rapidfire</code><span class="sig-paren">(</span><em>max_nlaunch=-1</em>, <em>max_loops=1</em>, <em>sleep_time=5</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyLauncher.rapidfire"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyLauncher.rapidfire" title="Permalink to this definition">¶</a></dt>
<dd><p>Keeps submitting <cite>Tasks</cite> until we are out of jobs or no job is ready to run.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>max_nlaunch</strong> – Maximum number of launches. default: no limit.</p></li>
<li><p><strong>max_loops</strong> – Maximum number of loops</p></li>
<li><p><strong>sleep_time</strong> – seconds to sleep between rapidfire loop iterations</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The number of tasks launched.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyLauncher.single_shot">
<code class="descname">single_shot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyLauncher.single_shot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyLauncher.single_shot" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the first <code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code> than is ready for execution.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Number of jobs launched.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler">
<em class="property">class </em><code class="descname">PyFlowScheduler</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This object schedules the submission of the tasks in a <code class="xref py py-class docutils literal notranslate"><span class="pre">Flow</span></code>.
There are two types of errors that might occur during the execution of the jobs:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>Python exceptions</p></li>
<li><p>Errors in the ab-initio code</p></li>
</ol>
</div></blockquote>
<p>Python exceptions are easy to detect and are usually due to a bug in the python code or random errors such as IOError.
The set of errors in the ab-initio is much much broader. It includes wrong input data, segmentation
faults, problems with the resource manager, etc. The flow tries to handle the most common cases
but there’s still a lot of room for improvement.
Note, in particular, that <cite>PyFlowScheduler</cite> will shutdown automatically in the following cases:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>The number of python exceptions is > max_num_pyexcs</p></li>
<li><p>The number of task errors (i.e. the number of tasks whose status is S_ERROR) is > max_num_abierrs</p></li>
<li><p>The number of jobs launched becomes greater than (<cite>safety_ratio</cite> * total_number_of_tasks).</p></li>
<li><p>The scheduler will send an email to the user (specified by <cite>mailto</cite>) every <cite>remindme_s</cite> seconds.
If the mail cannot be sent, the scheduler will shutdown automatically.
This check prevents the scheduler from being trapped in an infinite loop.</p></li>
</ol>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>weeks</strong> – number of weeks to wait (DEFAULT: 0).</p></li>
<li><p><strong>days</strong> – number of days to wait (DEFAULT: 0).</p></li>
<li><p><strong>hours</strong> – number of hours to wait (DEFAULT: 0).</p></li>
<li><p><strong>minutes</strong> – number of minutes to wait (DEFAULT: 0).</p></li>
<li><p><strong>seconds</strong> – number of seconds to wait (DEFAULT: 0).</p></li>
<li><p><strong>mailto</strong> – The scheduler will send an email to <cite>mailto</cite> every <cite>remindme_s</cite> seconds.
(DEFAULT: None i.e. not used).</p></li>
<li><p><strong>verbose</strong> – (int) verbosity level. (DEFAULT: 0)</p></li>
<li><p><strong>use_dynamic_manager</strong> – “yes” if the <code class="xref py py-class docutils literal notranslate"><span class="pre">TaskManager</span></code> must be re-initialized from
file before launching the jobs. (DEFAULT: “no”)</p></li>
<li><p><strong>max_njobs_inqueue</strong> – Limit on the number of jobs that can be present in the queue. (DEFAULT: 200)</p></li>
<li><p><strong>max_ncores_used</strong> – Maximum number of cores that can be used by the scheduler.</p></li>
<li><p><strong>remindme_s</strong> – The scheduler will send an email to the user specified
by <cite>mailto</cite> every <cite>remindme_s</cite> seconds. (int, DEFAULT: 1 day).</p></li>
<li><p><strong>max_num_pyexcs</strong> – The scheduler will exit if the number of python exceptions is > max_num_pyexcs
(int, DEFAULT: 0)</p></li>
<li><p><strong>max_num_abierrs</strong> – The scheduler will exit if the number of errored tasks is > max_num_abierrs
(int, DEFAULT: 0)</p></li>
<li><p><strong>safety_ratio</strong> – The scheduler will exits if the number of jobs launched becomes greater than
<cite>safety_ratio</cite> * total_number_of_tasks_in_flow. (int, DEFAULT: 5)</p></li>
<li><p><strong>max_nlaunches</strong> – Maximum number of tasks launched in a single iteration of the scheduler.
(DEFAULT: -1 i.e. no limit)</p></li>
<li><p><strong>debug</strong> – Debug level. Use 0 for production (int, DEFAULT: 0)</p></li>
<li><p><strong>fix_qcritical</strong> – “yes” if the launcher should try to fix QCritical Errors (DEFAULT: “no”)</p></li>
<li><p><strong>rmflow</strong> – If “yes”, the scheduler will remove the flow directory if the calculation
completed successfully. (DEFAULT: “no”)</p></li>
<li><p><strong>killjobs_if_errors</strong> – “yes” if the scheduler should try to kill all the runnnig jobs
before exiting due to an error. (DEFAULT: “yes”)</p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.Error">
<code class="descname">Error</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">PyFlowSchedulerError</span></code></p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.USER_CONFIG_DIR">
<code class="descname">USER_CONFIG_DIR</code><em class="property"> = '/Users/shyue/.abinit/abipy'</em><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.USER_CONFIG_DIR" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.YAML_FILE">
<code class="descname">YAML_FILE</code><em class="property"> = 'scheduler.yml'</em><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.YAML_FILE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.add_flow">
<code class="descname">add_flow</code><span class="sig-paren">(</span><em>flow</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.add_flow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.add_flow" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an <code class="xref py py-class docutils literal notranslate"><span class="pre">Flow</span></code> flow to the scheduler.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.autodoc">
<em class="property">classmethod </em><code class="descname">autodoc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.autodoc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.autodoc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.callback">
<code class="descname">callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.callback" title="Permalink to this definition">¶</a></dt>
<dd><p>The function that will be executed by the scheduler.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.cleanup">
<code class="descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Cleanup routine: remove the pid file and save the pickle database</p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.flow">
<code class="descname">flow</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.flow" title="Permalink to this definition">¶</a></dt>
<dd><p><cite>Flow</cite>.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.from_file">
<em class="property">classmethod </em><code class="descname">from_file</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.from_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Read the configuration parameters from a Yaml file.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.from_string">
<em class="property">classmethod </em><code class="descname">from_string</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.from_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.from_string" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an istance from string s containing a YAML dictionary.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.from_user_config">
<em class="property">classmethod </em><code class="descname">from_user_config</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.from_user_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.from_user_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize the <a class="reference internal" href="#pymatgen.io.abinit.launcher.PyFlowScheduler" title="pymatgen.io.abinit.launcher.PyFlowScheduler"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyFlowScheduler</span></code></a> from the YAML file ‘scheduler.yml’.
Search first in the working directory and then in the configuration directory of abipy.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>RuntimeError</strong> – </p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.get_delta_etime">
<code class="descname">get_delta_etime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.get_delta_etime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.get_delta_etime" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a <cite>timedelta</cite> object representing with the elapsed time.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.num_excs">
<code class="descname">num_excs</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.num_excs" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of exceptions raised so far.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.pid">
<code class="descname">pid</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.pid" title="Permalink to this definition">¶</a></dt>
<dd><p>The pid of the process associated to the scheduler.</p>
</dd></dl>
<dl class="attribute">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.pid_file">
<code class="descname">pid_file</code><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.pid_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Absolute path of the file with the pid.
The file is located in the workdir of the flow</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.send_email">
<code class="descname">send_email</code><span class="sig-paren">(</span><em>msg</em>, <em>tag=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.send_email"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.send_email" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an e-mail before completing the shutdown.
Returns 0 if success.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.shutdown">
<code class="descname">shutdown</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.shutdown" title="Permalink to this definition">¶</a></dt>
<dd><p>Shutdown the scheduler.</p>
</dd></dl>
<dl class="method">
<dt id="pymatgen.io.abinit.launcher.PyFlowScheduler.start">
<code class="descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pymatgen/io/abinit/launcher.html#PyFlowScheduler.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pymatgen.io.abinit.launcher.PyFlowScheduler.start" title="Permalink to this definition">¶</a></dt>
<dd><p>Starts the scheduler in a new thread. Returns 0 if success.
In standalone mode, this method will block until there are no more scheduled jobs.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pymatgen.io.abinit.launcher.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pymatgen 2019.5.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011, Pymatgen Development Team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.0.1.
</div>
<div class="footer">This page uses <a href="http://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
document.documentElement.firstChild.appendChild(ga);
})();
</script>
</div>
</body>
</html>