-
Notifications
You must be signed in to change notification settings - Fork 189
/
Copy pathfireworks.scripts.html
522 lines (455 loc) · 86.8 KB
/
fireworks.scripts.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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<!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>fireworks.scripts package — FireWorks 2.0.4 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/nature.css?v=b0beeceb" />
<script src="_static/documentation_options.js?v=adc66a14"></script>
<script src="_static/doctools.js?v=9bcbadda"></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 href='https://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>
</head><body>
<div class="related" role="navigation" aria-label="Related">
<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">FireWorks 2.0.4 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">fireworks.scripts package</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="fireworks-scripts-package">
<h1>fireworks.scripts package<a class="headerlink" href="#fireworks-scripts-package" title="Link to this heading">¶</a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="fireworks.scripts.tests.html">fireworks.scripts.tests package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="fireworks.scripts.tests.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="fireworks.scripts.tests.html#fireworks-scripts-tests-test-lpad-run-module">fireworks.scripts.tests.test_lpad_run module</a></li>
<li class="toctree-l2"><a class="reference internal" href="fireworks.scripts.tests.html#fireworks-scripts-tests-test-mlaunch-run-module">fireworks.scripts.tests.test_mlaunch_run module</a></li>
<li class="toctree-l2"><a class="reference internal" href="fireworks.scripts.tests.html#fireworks-scripts-tests-test-qlaunch-run-module">fireworks.scripts.tests.test_qlaunch_run module</a></li>
<li class="toctree-l2"><a class="reference internal" href="fireworks.scripts.tests.html#fireworks-scripts-tests-test-rlaunch-run-module">fireworks.scripts.tests.test_rlaunch_run module</a></li>
<li class="toctree-l2"><a class="reference internal" href="fireworks.scripts.tests.html#module-fireworks.scripts.tests">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
</section>
<section id="module-fireworks.scripts.lpad_run">
<span id="fireworks-scripts-lpad-run-module"></span><h2>fireworks.scripts.lpad_run module<a class="headerlink" href="#module-fireworks.scripts.lpad_run" title="Link to this heading">¶</a></h2>
<p>A runnable script for managing a FireWorks database (a command-line interface to launchpad.py).</p>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.add_scripts">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">add_scripts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.add_scripts" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.add_wf">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">add_wf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.add_wf" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.add_wf_dir">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">add_wf_dir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.add_wf_dir" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.append_wf">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">append_wf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.append_wf" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.archive">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">archive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.archive" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.arg_positive_int">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">arg_positive_int</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.arg_positive_int" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.cancel_qid">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">cancel_qid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.cancel_qid" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.check_wf">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">check_wf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.check_wf" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.defuse_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">defuse_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.defuse_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.defuse_wfs">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">defuse_wfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.defuse_wfs" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.delete_wfs">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">delete_wfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.delete_wfs" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.detect_lostruns">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">detect_lostruns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.detect_lostruns" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.detect_unreserved">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">detect_unreserved</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.detect_unreserved" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.dump_wf">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">dump_wf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.dump_wf" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.forget_offline">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">forget_offline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.forget_offline" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_children">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_children</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">links</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_depth</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_children" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_fw_ids_helper">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_fw_ids_helper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="fireworks.core.html#fireworks.core.launchpad.LaunchPad" title="fireworks.core.launchpad.LaunchPad"><span class="pre">LaunchPad</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">count_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_fw_ids_helper" title="Link to this definition">¶</a></dt>
<dd><p>Build fws query from command line options and submit.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>lp</strong> (<em>fireworks.core.firework.Launchpad</em>)</p></li>
<li><p><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><em>argparse.Namespace</em></a>)</p></li>
<li><p><strong>count_only</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – if None, then looked up in args.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>resulting fw_ids or count of fws in query.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>] | <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_fws_helper">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_fws_helper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="fireworks.core.html#fireworks.core.launchpad.LaunchPad" title="fireworks.core.launchpad.LaunchPad"><span class="pre">LaunchPad</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_fws_helper" title="Link to this definition">¶</a></dt>
<dd><p>Get fws from ids in a representation according to args.display_format.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_fws_in_wfs">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_fws_in_wfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_fws_in_wfs" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_launchdir">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_launchdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_launchdir" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_lp">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_lp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="fireworks.core.html#fireworks.core.launchpad.LaunchPad" title="fireworks.core.launchpad.LaunchPad"><span class="pre">LaunchPad</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_lp" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_output">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_output</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">objs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_output" title="Link to this definition">¶</a></dt>
<dd><p>Prints output on stdout</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_qid">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_qid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_qid" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.get_wfs">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">get_wfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.get_wfs" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.init_yaml">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">init_yaml</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.init_yaml" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.introspect">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">introspect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.introspect" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.lpad">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">lpad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.lpad" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.maintain">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">maintain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.maintain" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.orphaned">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">orphaned</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.orphaned" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.parse_helper">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">parse_helper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="fireworks.core.html#fireworks.core.launchpad.LaunchPad" title="fireworks.core.launchpad.LaunchPad"><span class="pre">LaunchPad</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">wf_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_pw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.parse_helper" title="Link to this definition">¶</a></dt>
<dd><p>Helper method to parse args that can take either id, name, state or query.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>args</strong> – Namespace of parsed CLI arguments.</p></li>
<li><p><strong>wf_mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, will query lp for workflow instead of fireworks IDs.</p></li>
<li><p><strong>skip_pw</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, skip PW check. Defaults to False.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Firework or Workflow IDs.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.pause_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">pause_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.pause_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.pause_wfs">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">pause_wfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.pause_wfs" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.print_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">print_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ids</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.print_fws" title="Link to this definition">¶</a></dt>
<dd><p>Prints results of some FireWorks query to stdout.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.pw_check">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">pw_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_pw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.pw_check" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.recover_offline">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">recover_offline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.recover_offline" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.refresh">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">refresh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.refresh" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.reignite_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">reignite_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.reignite_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.reignite_wfs">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">reignite_wfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.reignite_wfs" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.report">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.report" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.rerun_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">rerun_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.rerun_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.reset">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.reset" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.resume_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">resume_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.resume_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.set_priority">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">set_priority</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.set_priority" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.track_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">track_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.track_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.tuneup">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">tuneup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.tuneup" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.unlock">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">unlock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.unlock" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.update_fws">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">update_fws</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.update_fws" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.lpad_run.webgui">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.lpad_run.</span></span><span class="sig-name descname"><span class="pre">webgui</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.13)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.lpad_run.webgui" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</section>
<section id="module-fireworks.scripts.mlaunch_run">
<span id="fireworks-scripts-mlaunch-run-module"></span><h2>fireworks.scripts.mlaunch_run module<a class="headerlink" href="#module-fireworks.scripts.mlaunch_run" title="Link to this heading">¶</a></h2>
<p>A runnable script to launch Job Packing (Multiple) Rockets.</p>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.mlaunch_run.mlaunch">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.mlaunch_run.</span></span><span class="sig-name descname"><span class="pre">mlaunch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#fireworks.scripts.mlaunch_run.mlaunch" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</section>
<section id="module-fireworks.scripts.qlaunch_run">
<span id="fireworks-scripts-qlaunch-run-module"></span><h2>fireworks.scripts.qlaunch_run module<a class="headerlink" href="#module-fireworks.scripts.qlaunch_run" title="Link to this heading">¶</a></h2>
<p>A runnable script for launching rockets (a command-line interface to queue_launcher.py).</p>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.qlaunch_run.do_launch">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.qlaunch_run.</span></span><span class="sig-name descname"><span class="pre">do_launch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.qlaunch_run.do_launch" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.qlaunch_run.qlaunch">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.qlaunch_run.</span></span><span class="sig-name descname"><span class="pre">qlaunch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#fireworks.scripts.qlaunch_run.qlaunch" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</section>
<section id="module-fireworks.scripts.rlaunch_run">
<span id="fireworks-scripts-rlaunch-run-module"></span><h2>fireworks.scripts.rlaunch_run module<a class="headerlink" href="#module-fireworks.scripts.rlaunch_run" title="Link to this heading">¶</a></h2>
<p>A runnable script to launch a single Rocket (a command-line interface to rocket_launcher.py).</p>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.rlaunch_run.handle_interrupt">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.rlaunch_run.</span></span><span class="sig-name descname"><span class="pre">handle_interrupt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signum</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#fireworks.scripts.rlaunch_run.handle_interrupt" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="fireworks.scripts.rlaunch_run.rlaunch">
<span class="sig-prename descclassname"><span class="pre">fireworks.scripts.rlaunch_run.</span></span><span class="sig-name descname"><span class="pre">rlaunch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#fireworks.scripts.rlaunch_run.rlaunch" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</section>
<section id="module-fireworks.scripts">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-fireworks.scripts" title="Link to this heading">¶</a></h2>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">fireworks.scripts package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-fireworks.scripts.lpad_run">fireworks.scripts.lpad_run module</a><ul>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.add_scripts"><code class="docutils literal notranslate"><span class="pre">add_scripts()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.add_wf"><code class="docutils literal notranslate"><span class="pre">add_wf()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.add_wf_dir"><code class="docutils literal notranslate"><span class="pre">add_wf_dir()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.append_wf"><code class="docutils literal notranslate"><span class="pre">append_wf()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.archive"><code class="docutils literal notranslate"><span class="pre">archive()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.arg_positive_int"><code class="docutils literal notranslate"><span class="pre">arg_positive_int()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.cancel_qid"><code class="docutils literal notranslate"><span class="pre">cancel_qid()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.check_wf"><code class="docutils literal notranslate"><span class="pre">check_wf()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.defuse_fws"><code class="docutils literal notranslate"><span class="pre">defuse_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.defuse_wfs"><code class="docutils literal notranslate"><span class="pre">defuse_wfs()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.delete_wfs"><code class="docutils literal notranslate"><span class="pre">delete_wfs()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.detect_lostruns"><code class="docutils literal notranslate"><span class="pre">detect_lostruns()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.detect_unreserved"><code class="docutils literal notranslate"><span class="pre">detect_unreserved()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.dump_wf"><code class="docutils literal notranslate"><span class="pre">dump_wf()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.forget_offline"><code class="docutils literal notranslate"><span class="pre">forget_offline()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_children"><code class="docutils literal notranslate"><span class="pre">get_children()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_fw_ids_helper"><code class="docutils literal notranslate"><span class="pre">get_fw_ids_helper()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_fws"><code class="docutils literal notranslate"><span class="pre">get_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_fws_helper"><code class="docutils literal notranslate"><span class="pre">get_fws_helper()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_fws_in_wfs"><code class="docutils literal notranslate"><span class="pre">get_fws_in_wfs()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_launchdir"><code class="docutils literal notranslate"><span class="pre">get_launchdir()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_lp"><code class="docutils literal notranslate"><span class="pre">get_lp()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_output"><code class="docutils literal notranslate"><span class="pre">get_output()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_qid"><code class="docutils literal notranslate"><span class="pre">get_qid()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.get_wfs"><code class="docutils literal notranslate"><span class="pre">get_wfs()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.init_yaml"><code class="docutils literal notranslate"><span class="pre">init_yaml()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.introspect"><code class="docutils literal notranslate"><span class="pre">introspect()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.lpad"><code class="docutils literal notranslate"><span class="pre">lpad()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.maintain"><code class="docutils literal notranslate"><span class="pre">maintain()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.orphaned"><code class="docutils literal notranslate"><span class="pre">orphaned()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.parse_helper"><code class="docutils literal notranslate"><span class="pre">parse_helper()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.pause_fws"><code class="docutils literal notranslate"><span class="pre">pause_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.pause_wfs"><code class="docutils literal notranslate"><span class="pre">pause_wfs()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.print_fws"><code class="docutils literal notranslate"><span class="pre">print_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.pw_check"><code class="docutils literal notranslate"><span class="pre">pw_check()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.recover_offline"><code class="docutils literal notranslate"><span class="pre">recover_offline()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.refresh"><code class="docutils literal notranslate"><span class="pre">refresh()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.reignite_fws"><code class="docutils literal notranslate"><span class="pre">reignite_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.reignite_wfs"><code class="docutils literal notranslate"><span class="pre">reignite_wfs()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.report"><code class="docutils literal notranslate"><span class="pre">report()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.rerun_fws"><code class="docutils literal notranslate"><span class="pre">rerun_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.reset"><code class="docutils literal notranslate"><span class="pre">reset()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.resume_fws"><code class="docutils literal notranslate"><span class="pre">resume_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.set_priority"><code class="docutils literal notranslate"><span class="pre">set_priority()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.track_fws"><code class="docutils literal notranslate"><span class="pre">track_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.tuneup"><code class="docutils literal notranslate"><span class="pre">tuneup()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.unlock"><code class="docutils literal notranslate"><span class="pre">unlock()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.update_fws"><code class="docutils literal notranslate"><span class="pre">update_fws()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.lpad_run.webgui"><code class="docutils literal notranslate"><span class="pre">webgui()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.scripts.mlaunch_run">fireworks.scripts.mlaunch_run module</a><ul>
<li><a class="reference internal" href="#fireworks.scripts.mlaunch_run.mlaunch"><code class="docutils literal notranslate"><span class="pre">mlaunch()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.scripts.qlaunch_run">fireworks.scripts.qlaunch_run module</a><ul>
<li><a class="reference internal" href="#fireworks.scripts.qlaunch_run.do_launch"><code class="docutils literal notranslate"><span class="pre">do_launch()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.qlaunch_run.qlaunch"><code class="docutils literal notranslate"><span class="pre">qlaunch()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.scripts.rlaunch_run">fireworks.scripts.rlaunch_run module</a><ul>
<li><a class="reference internal" href="#fireworks.scripts.rlaunch_run.handle_interrupt"><code class="docutils literal notranslate"><span class="pre">handle_interrupt()</span></code></a></li>
<li><a class="reference internal" href="#fireworks.scripts.rlaunch_run.rlaunch"><code class="docutils literal notranslate"><span class="pre">rlaunch()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-fireworks.scripts">Module contents</a></li>
</ul>
</li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/fireworks.scripts.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search 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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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">FireWorks 2.0.4 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">fireworks.scripts package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013, Anubhav Jain.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-53488807-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>