-
Notifications
You must be signed in to change notification settings - Fork 189
/
Copy pathchangelog.html
1211 lines (1198 loc) · 60 KB
/
changelog.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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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 Changelog — 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 rel="prev" title="The Comprehensive Guide to Writing Firetasks with Python" href="guide_to_writing_firetasks.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="right" >
<a href="guide_to_writing_firetasks.html" title="The Comprehensive Guide to Writing Firetasks with Python"
accesskey="P">previous</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 Changelog</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="fireworks-changelog">
<h1>FireWorks Changelog<a class="headerlink" href="#fireworks-changelog" title="Link to this heading">¶</a></h1>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>Starting v1.9.7 onwards, the changelog is no longer maintained. Please check the Github commit log for a record of changes.</p>
</div>
<p><strong>v1.9.6</strong></p>
<ul class="simple">
<li><p>avoid checking the number of jobs in the queue if not needed (G. Petretto)</p></li>
<li><p>Avoid failures due to encoding issues in tracker (J. Hörmann)</p></li>
<li><p>Filepad accessible via TLS/SSL encrypted connection (J. Hörmann)</p></li>
<li><p>allow propagating modified spec not only to direct children, but along all descendants down to workflow leaves by adding a ‘propagate’ flag to FWAction. (J. Hörmann)</p></li>
<li><p>update some dependency versions</p></li>
<li><p>misc fixes and updates (mamachra, J. Hörmann, I. Kondov, A. Jain)</p></li>
</ul>
<p><strong>v1.9.5</strong></p>
<ul class="simple">
<li><p>document new help forum!</p></li>
<li><p>ability to add custom kwargs to the LaunchPad MongoClient using the YAML format (thanks to I. Kondov for pointing in this direction)</p></li>
<li><p>restore “text_mode” for anyone having problems with the new binary FilePad</p></li>
<li><p>rework lostruns recovery</p></li>
<li><p>actually use launch_dir in update_checkpoint (hopefully shouldn’t change any behavior)</p></li>
<li><p>prevent “zombie” reruns of offline runs when marking them as fizzled or rerun. (thanks to jotelha for suggestion)</p></li>
<li><p>Use mod_spec instead of update_spec to pass on out-/infiles along Fireworks (J. Hörmann)</p></li>
<li><p>allow binary files in FilePad / handle filepad files as binary always (J. Hörmann)</p></li>
<li><p>update SLURM job id parsing (G. Petretto)</p></li>
<li><p>update dependencies</p></li>
</ul>
<p><strong>v1.9.4</strong></p>
<ul class="simple">
<li><p>filepad tasks to get files by query (Github user: J. Hörmann)</p></li>
<li><p>the _pass_job_info command now also passes the FW state of the parent (M. Siron)</p></li>
<li><p>bugfix for detect_lostruns command (P. Huck)</p></li>
<li><p>http/https fix for web gui (D. Winston)</p></li>
</ul>
<p><strong>v1.9.3</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>if you set <code class="docutils literal notranslate"><span class="pre">optional_params</span></code> in your FireTask, these will be strictly checked in FWS v1.9.3 and greater!</p>
</div>
<ul class="simple">
<li><p>strict checking of <code class="docutils literal notranslate"><span class="pre">optional_params</span></code> in a FireTask. If (and only if) <code class="docutils literal notranslate"><span class="pre">optional_params</span></code> is set, any parameter passed to a FireTask outside of <code class="docutils literal notranslate"><span class="pre">required_params</span></code> and <code class="docutils literal notranslate"><span class="pre">optional_params</span></code> will throw an error. If you want to merely suggest potential optional parameters without strict checking, we suggest you rename to <code class="docutils literal notranslate"><span class="pre">other_params</span></code> as was done for <code class="docutils literal notranslate"><span class="pre">ScriptTask</span></code>.</p></li>
<li><p>add option for detect_lostruns command to set launch restrictions (e.g., restrict to certain host) (thanks to M. Siron for suggestion)</p></li>
<li><p>Add <code class="docutils literal notranslate"><span class="pre">core_spec</span></code> to SLURM template (M. Horton)</p></li>
</ul>
<p><strong>v1.9.2</strong></p>
<ul class="simple">
<li><p>code cleanups (should not affect any functions)</p></li>
<li><p>Add mail_type and mail_user to SLURM template for notifications (M. Horton)</p></li>
</ul>
<p><strong>v1.9.1</strong></p>
<ul class="simple">
<li><p>fix webgui JSON issue (D. Winston)</p></li>
<li><p>add time_min to SLURM template (M. Horton)</p></li>
</ul>
<p><strong>v1.9.0</strong></p>
<ul class="simple">
<li><p>fix backward compatibility issues in using a MongoDB URI, added a separate “uri_mode” parameter. (thanks to M. Bercx for pointing out)</p></li>
</ul>
<p><strong>v1.8.9</strong></p>
<ul class="simple">
<li><p>added ability to connect via MongoDB URI and added ‘lpad init -u’ command.</p></li>
</ul>
<p><strong>v1.8.8</strong></p>
<ul class="simple">
<li><p>fix insertion order bug in append_wf() for Py<=3.5 (thanks to M. Jager)</p></li>
<li><p>fix recover_launch with MSONable objects (G. Petretto)</p></li>
<li><p>option to set priority of an entire workflow at once (G. Petretto)</p></li>
</ul>
<p><strong>v1.8.7</strong></p>
<ul class="simple">
<li><p>fix lpad webgui bug (thanks to J. Hörmann)</p></li>
</ul>
<p><strong>v1.8.6</strong></p>
<ul class="simple">
<li><p>fix authsource in updated authentication (M. Dylla)</p></li>
<li><p>doc update for PyTask (I. Kondov)</p></li>
</ul>
<p><strong>v1.8.5</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>the code to authenticate to databases was changed in this version. If you encounter problems after updating, contact the help group.</p>
</div>
<ul class="simple">
<li><p>save action in GridFS if Launch document too large (G. Petretto)</p></li>
<li><p>fixed Jinja functionality in TemplateWriterTask (E. Ateljevich)</p></li>
<li><p>update authentication method to not use deprecated db.authenticate</p></li>
<li><p>small updates to tutorials / docs to reflect user questions</p></li>
</ul>
<p><strong>v1.8.4</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>this version changes the manner in which one authenticates to the web gui via Python (command line is unaffected). You no longer set environment variables. See docs on the web gui for more information.</p>
</div>
<ul class="simple">
<li><p>improve the way lpad webgui handles arguments (no more environment variables!)</p></li>
<li><p>allow a user to set a username/password to webgui from the command line</p></li>
</ul>
<p><strong>v1.8.3</strong></p>
<ul class="simple">
<li><p>better Dupefinder.verify() (thanks to A. Takahashi)</p></li>
<li><p>fix missing fw_id parameter passing in qlaunch command (thanks to A. Takahashi)</p></li>
</ul>
<p><strong>v1.8.2</strong></p>
<ul class="simple">
<li><p>call Dupefinder.verify() properly (thanks to A. Takahashi)</p></li>
<li><p>allow authsource on LaunchPad (thanks to agrav, C. Pashartis)</p></li>
<li><p>better contribution docs (A. Dunn, A. Jain)</p></li>
<li><p>webgui bugfix (D. Winston)</p></li>
<li><p>better FilePad authentication and docs</p></li>
</ul>
<p><strong>v1.8.1</strong></p>
<ul class="simple">
<li><p>bugfix on FW rerun where child states were not updated properly (G. Petretto)</p></li>
<li><p>Added –mem and –mem-per-cpu to SLURM template (S. Torrisi)</p></li>
<li><p>update paramiko version for better security</p></li>
</ul>
<p><strong>v1.8.0</strong></p>
<ul class="simple">
<li><p>bugfix remote_keyfile option to qlaunch (thanks to A. Takahashi)</p></li>
</ul>
<p><strong>v1.7.9</strong></p>
<ul class="simple">
<li><p>add remote_keyfile option to qlaunch</p></li>
</ul>
<p><strong>v1.7.8</strong></p>
<ul class="simple">
<li><p>upgrade to use Fabric 2 for Py3 compatibility (R. Gowers)</p></li>
</ul>
<p><strong>v1.7.7</strong></p>
<ul class="simple">
<li><p>fix bug in Workflow.state pertaining to when _allow_fizzled_parents is set (R. Gowers)</p></li>
<li><p>minor docfix (R. Gowers)</p></li>
</ul>
<p><strong>v1.7.6</strong></p>
<ul class="simple">
<li><p>greatly improve speed of workflow refresh with many parents (huge thanks to Github user tahorst)</p></li>
</ul>
<p><strong>v1.7.5</strong></p>
<ul class="simple">
<li><p>minor bug fixes (G. Petretto)</p></li>
</ul>
<p><strong>v1.7.4</strong></p>
<ul class="simple">
<li><p>multiple fw_ids in lpad are always comma-separated, fix for autodocs</p></li>
<li><p>offline mode more naturally supports gzipped FW_offline.json</p></li>
<li><p>add a “query” filter option for detect_lostruns</p></li>
<li><p>tutorial updates on updating Fireworks (S. Dwaraknath)</p></li>
</ul>
<p><strong>v1.7.3</strong></p>
<ul class="simple">
<li><p>minor update to SLURM template (E. Sivonxay)</p></li>
<li><p>minor doc updates</p></li>
</ul>
<p><strong>v1.7.2</strong></p>
<ul class="simple">
<li><p>fix FW_offline if job changes directory</p></li>
<li><p>fixed lpad cli when performing wflow operations (R. Gowers)</p></li>
<li><p>Add signal to SLURM queue adapter (S. Dwaraknath)</p></li>
</ul>
<p><strong>v1.7.1</strong></p>
<ul class="simple">
<li><p>update FWS rapidfire launch logic (thanks to Primer for suggestions)</p></li>
<li><p>upgrade CircleCI testing (A. Dunn)</p></li>
</ul>
<p><strong>v1.6.9</strong></p>
<ul class="simple">
<li><p>important bugfix: bulk insert workflow inserted negative FW_ids (G. Petretto)</p></li>
<li><p>option to delete launch dirs when deleting workflow (G. Petretto)</p></li>
<li><p>modify FireTask to be compatible with pickle/unpickle (M. Henderson)</p></li>
<li><p>switch to ruamel.yaml to use more up to date YAML standard</p></li>
</ul>
<p><strong>v1.6.8</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>a bug in bulk insert workflow function resulting in negative FW_ids was fixed in v1.6.9</p>
</div>
<ul class="simple">
<li><p>add <code class="docutils literal notranslate"><span class="pre">launch_idx</span></code> option to <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">get_launchdir</span></code> command (as requested by S. Dwaraknath)</p></li>
</ul>
<p><strong>v1.6.7</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>a bug in bulk insert workflow function resulting in negative FW_ids was fixed in v1.6.9</p>
</div>
<ul class="simple">
<li><p>lpad bulk insert workflow function - if you have 10 or more workflows to enter, do it 10X faster using this function (J. Montoya)</p></li>
<li><p>add <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">get_launchdir</span> <span class="pre"><FW_ID></span></code> function. e.g., can now do “cd <cite>get_launchdir <FW_ID></cite> to change to the most recent launch dir of a FW.</p></li>
</ul>
<p><strong>v1.6.6</strong></p>
<ul class="simple">
<li><p>Improve qlaunch rapidfire (with guidance from A. Gopalan)</p></li>
</ul>
<p><strong>v1.6.5</strong></p>
<ul class="simple">
<li><p>sketch of MOAB queue adapter (with guidance from A. Gopalan)</p></li>
<li><p>add option to <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">webgui</span></code> for number of server processes (D. Winston)</p></li>
<li><p>more sanity checks to workflow (I. Kondov)</p></li>
</ul>
<p><strong>v1.6.4</strong></p>
<ul class="simple">
<li><p>new workflow check option that validates and plots a workflow using python-igraph (I. Kondov)</p></li>
<li><p>misc. code cleanup</p></li>
</ul>
<p><strong>v1.6.3</strong></p>
<ul class="simple">
<li><p>allow FWorker to have multiple categories (thanks to Johannes Jansson for the suggestion)</p></li>
<li><p>FWorker can set <code class="docutils literal notranslate"><span class="pre">__none__</span></code> for category which only pulls jobs with empty categories</p></li>
</ul>
<p><strong>v1.6.2</strong></p>
<ul class="simple">
<li><p>lpad argparser to allow comma separated lists when using -i and –fw_id (E. Sivonxay)</p></li>
<li><p>important fix to cmd_line_tests.sh</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pdb_on_exception</span></code> option to use Python debugger to debug failed jobs (J. Montoya)</p></li>
</ul>
<p><strong>v1.6.1</strong></p>
<ul class="simple">
<li><p>some fixes to config file determination (A. Jain, G. Petretto)</p></li>
<li><p>add append_wf and dump_wf commands to lpad (I. Kondov)</p></li>
<li><p>faster GUI load (D. Winston)</p></li>
<li><p>minor code improvements and help/warning messages for the user (M. Horton)</p></li>
</ul>
<p><strong>v1.6.0</strong></p>
<ul class="simple">
<li><p>fixes for task-level recovery (J. Montoya)</p></li>
<li><p>LSF queueadapter takes into account job counts by queue (J. Boes)</p></li>
<li><p>some unit test improvements (I. Kondov)</p></li>
</ul>
<p><strong>v1.5.9</strong></p>
<ul class="simple">
<li><p>Py2 bugfix</p></li>
</ul>
<p><strong>v1.5.8</strong></p>
<ul class="simple">
<li><p>New data flow built-in Firetasks (I. Kondov)</p></li>
</ul>
<p><strong>v1.5.7</strong></p>
<ul class="simple">
<li><p>Improve performance of workflow add to DB for large workflows (R. Gowers)</p></li>
</ul>
<p><strong>v1.5.5</strong></p>
<ul class="simple">
<li><p>Better handling of SSL certs (I. Kondov)</p></li>
<li><p>Improve performance of fw rerun (R. Gowers)</p></li>
</ul>
<p><strong>v1.5.4</strong></p>
<ul class="simple">
<li><p>fix some logic re:which config files to use</p></li>
</ul>
<p><strong>v1.5.3</strong></p>
<ul class="simple">
<li><p>rapidfire with nlaunches=0 now loops until no READY or WAITINGS FWs via new launchpad.future_run_exists() (R. Gowers)</p></li>
</ul>
<p><strong>v1.5.2</strong></p>
<ul class="simple">
<li><p>minor web gui improvements</p></li>
<li><p>installation doc updates (R. Lahe)</p></li>
</ul>
<p><strong>v1.5.1</strong></p>
<ul class="simple">
<li><p>add visual dashboard feature to web gui (all graphics)</p></li>
<li><p>Fixes to SGE queue adapter (A. Ganose)</p></li>
</ul>
<p><strong>v1.5.0</strong></p>
<ul class="simple">
<li><p>redesigned web gui with visual plots (J. Montoya, A. Jain)</p></li>
<li><p>improved task-level recovery, including in offline mode (J. Montoya)</p></li>
</ul>
<p><strong>v1.4.8</strong></p>
<ul class="simple">
<li><p>Fix pip requirements</p></li>
</ul>
<p><strong>v1.4.7</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>pip may require manual dependency installation in this distribution</p>
</div>
<ul class="simple">
<li><p>Add new protocol for file transfer using <code class="docutils literal notranslate"><span class="pre">_files_in</span></code> and <code class="docutils literal notranslate"><span class="pre">_files_out</span></code> spec params (S.P. Ong)</p></li>
<li><p>update docs location to <a class="reference external" href="https://materialsproject.github.io/fireworks">https://materialsproject.github.io/fireworks</a></p></li>
</ul>
<p><strong>v1.4.6</strong></p>
<ul class="simple">
<li><p>doc link update</p></li>
</ul>
<p><strong>v1.4.5</strong></p>
<ul class="simple">
<li><p>hack to allow “_add_launchpad_and_fw_id” reserved spec to work in rlaunch multi mode</p></li>
</ul>
<p><strong>v1.4.4</strong></p>
<ul class="simple">
<li><p>better error message on FireTaskMeta required param missing</p></li>
<li><p>better error handling on refresh_wf error; such workflows should now show up as FIZZLED immediately</p></li>
<li><p>add remove_fws method to Workflow (K. Mathew)</p></li>
<li><p>minor doc updates</p></li>
</ul>
<p><strong>v1.4.3</strong></p>
<ul class="simple">
<li><p>only put tasks inside FW spec upon serialization! (see announcement on dev list)</p></li>
<li><p>add qlauncher support for remote shell (D. Dotson)</p></li>
<li><p>don’t allow creating an empty workflow</p></li>
<li><p>rare bugfix for rocket (G. Petretto)</p></li>
<li><p>add gres support for Slurm (KeLiu)</p></li>
</ul>
<p><strong>v1.4.2</strong></p>
<ul class="simple">
<li><p>improvements to FilePad (K. Mathew)</p></li>
<li><p>Better logging for rapidfire rlaunch (S. Dwaraknath)</p></li>
<li><p>improve performance w/generator expressions (R. Gowers)</p></li>
<li><p>bugfix to webgui search (D. Winston)</p></li>
</ul>
<p><strong>v1.4.1</strong></p>
<ul class="simple">
<li><p>optional support for argcomplete (requires installing argcomplete)</p></li>
<li><p>more powerful update_spec command (S. Dwaraknath)</p></li>
<li><p>Py3 fix for multi_launch (X. Qu)</p></li>
<li><p>numpy serializes to lists (thanks to J. Kuck)</p></li>
<li><p>fix for qlaunch rapidfire that caused unintended stopping (thanks to J. Kuck)</p></li>
<li><p>multiple doc updates (A. Jain / K. Bhatt)</p></li>
</ul>
<p><strong>v1.4.0</strong></p>
<ul class="simple">
<li><p>mlaunch is now “rlaunch multi”. See docs (S. Dwaraknath)</p></li>
<li><p>For FireTask, we now suggest you use Firetask (more consistent naming) - (A. Jain)</p></li>
<li><p>Adds the FilePad, a way to store files in GridFS. See docs for more details (K. Mathew, A. Jain)</p></li>
<li><p>Add query ability to frontend (M. Aykol, D. Winston)</p></li>
<li><p>Add ability to “pause/resume” fireworks in addition to existing “defuse/reignite”. See docs (S. Dwaraknath)</p></li>
<li><p>Add sort ability in frontend (D. Waroquiers)</p></li>
<li><p>Misc frontend improvements (D. Winston, M. Aykol, A. Jain)</p></li>
<li><p>Add ability to move run dirs, i.e. update the database with location of runs after they are moved (A. Faghaninia, A. Jain)</p></li>
<li><p>Add ability to qlaunch a particular fw_id (J. Montoya)</p></li>
<li><p>Py3 compatibility (X. Qu, A. Faghaninia)</p></li>
<li><p>Fix lpad admin maintain (shenjh)</p></li>
<li><p>Fix to _pass_job_info (D. Waroquiers)</p></li>
<li><p>improved docs (J. Montoya, M. Aykol, A. Jain)</p></li>
</ul>
<p><strong>v1.3.9</strong></p>
<ul class="simple">
<li><p>import Tracker object more easily (J. Montoya)</p></li>
</ul>
<p><strong>v1.3.8</strong></p>
<ul class="simple">
<li><p>don’t enforce j=True for Mongo connections (S.P. Ong)</p></li>
<li><p>improve testing framework (S.P. Ong)</p></li>
<li><p>remove problems & inefficiencies in workflow refresh (thanks to G. Petretto)</p></li>
<li><p>properly update fw_states when you defuse a workflow</p></li>
<li><p>only enter _fizzled_parents into the database once - for efficiency, and to better track the provenance of what actually occurred during the run</p></li>
<li><p>minor bugfixes / comments</p></li>
</ul>
<p><strong>v1.3.7</strong></p>
<ul class="simple">
<li><p>minor doc updates</p></li>
<li><p>add ability to clear the task-level recovery, which gets stuck (J. Montoya)</p></li>
<li><p>py3k fixes (K. Matthew)</p></li>
<li><p>minor bugfixes</p></li>
</ul>
<p><strong>v1.3.6</strong></p>
<ul class="simple">
<li><p>greatly improved docstring formatting and accuracy (K. Mathew)</p></li>
<li><p>Py3K fixes (K. Mathew)</p></li>
<li><p>code cleanups (K. Mathew)</p></li>
<li><p>better PEP conformance (K. Mathew)</p></li>
<li><p>representative launch returns most recent launch (K. Mathew)</p></li>
</ul>
<p><strong>v1.3.5</strong></p>
<ul class="simple">
<li><p>forget about offline runs if a queue submission unsuccessful (thanks to D. Stansberry for pointing out the problem)</p></li>
<li><p>cleanups to project setup (S.P. Ong)</p></li>
</ul>
<p><strong>v1.3.4</strong></p>
<ul class="simple">
<li><p>add launches mode query (query launches collection when performing lpad tasks)</p></li>
<li><p>Add auth option to web app (S.P. Ong)</p></li>
<li><p>enhance webapp server w/gunicorn (D. Winston)</p></li>
<li><p>threshold parameter in introspect command</p></li>
<li><p>add license option to SLURM adapter</p></li>
<li><p>add fill mode to qlaunch for keeping jobs in the queue even when nothing in DB to run</p></li>
<li><p>fix njobs_queue bug</p></li>
<li><p>open compressed files in textmode to ensure py3k compatibility (K. Mathew)</p></li>
</ul>
<p><strong>v1.3.3</strong></p>
<ul class="simple">
<li><p>Load default FWorker location when running launch commands from Python</p></li>
<li><p>qlaunch: default maxjobs_queue is zero, meaning don’t automatically restrict to 10 jobs in queue</p></li>
<li><p>Add –wfquery and –fwquery options to <code class="docutils literal notranslate"><span class="pre">lpad_webgui</span></code> for advanced users (alpha version)</p></li>
</ul>
<p><strong>v1.3.2</strong></p>
<ul class="simple">
<li><p>update pymongo commands (X. Qu & A. Jain)</p></li>
<li><p>minor qadapter updates (D. Dotson & X. Qu)</p></li>
<li><p>very minor doc updates (S. Bajaj & A. Faghaninia)</p></li>
</ul>
<p><strong>v1.3.1</strong></p>
<ul class="simple">
<li><p>FileTransferTask has max_retry parameter (D. Dotson)</p></li>
<li><p>Allow copying workflows but w/reset ids (D. Dotson)</p></li>
<li><p>add <code class="docutils literal notranslate"><span class="pre">max_loops</span></code> option to rlaunch; this allows you to limit infinite mode to a few cycles</p></li>
</ul>
<p><strong>v1.3.0</strong></p>
<ul class="simple">
<li><p>fix datetime import (fixes broken queue_launcher) - (D. Winston)</p></li>
<li><p>fix datetime handler in __repr__</p></li>
<li><p>always unreserve if queue submission goes wrong (G. Petretto)</p></li>
</ul>
<p><strong>v1.2.9</strong></p>
<ul class="simple">
<li><p>add <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">admin</span> <span class="pre">unlock</span></code> command to force unlock of workflows</p></li>
<li><p>add <code class="docutils literal notranslate"><span class="pre">--timeout</span></code> option for rapidfire launches</p></li>
<li><p>add <code class="docutils literal notranslate"><span class="pre">user</span></code> parameter for FileTransferTask (D. Dotson)</p></li>
<li><p>fix bug in FileTransferTask (D. Dotson)</p></li>
</ul>
<p><strong>v1.2.8</strong></p>
<ul class="simple">
<li><p>fix spelling of <code class="docutils literal notranslate"><span class="pre">my_qadapter.yaml</span></code> (thanks to specter119)</p></li>
</ul>
<p><strong>v1.2.7</strong></p>
<ul class="simple">
<li><p>fix errant print statement</p></li>
</ul>
<p><strong>v1.2.6</strong></p>
<ul class="simple">
<li><p>add FWorker auto_load</p></li>
<li><p>add SSL cert support to LaunchPad (D. Cossey)</p></li>
<li><p>improve offline recovery (G. Petretto)</p></li>
<li><p>Add allow_gzipped option to Trackers</p></li>
</ul>
<p><strong>v1.2.5</strong></p>
<ul class="simple">
<li><p>add defuse_workflow to FWAction (thanks to H. Rusche)</p></li>
<li><p>New _add_fworker option in spec (D. Waroquiers)</p></li>
<li><p>fix workflow state when allow_fizzled_parents option used (D. Waroquiers)</p></li>
<li><p>doc updates and example workflows</p></li>
<li><p>fix minor frontend coloring issues</p></li>
</ul>
<p><strong>v1.2.4</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The deprecated <code class="docutils literal notranslate"><span class="pre">FireWork</span></code> class has been removed. Be sure to use <code class="docutils literal notranslate"><span class="pre">Firework</span></code> (see capitalization). Also, use <code class="docutils literal notranslate"><span class="pre">Workflow.from_Firework()</span></code>.</p>
</div>
<ul class="simple">
<li><p>remove deprecated capitalization of FireWork</p></li>
<li><p>better display of workflow info and reporting in frontend</p></li>
</ul>
<p><strong>v1.2.3</strong></p>
<ul class="simple">
<li><p>Greatly improve refresh performance of large workflows (G. Petretto)</p></li>
<li><p>FW Reporting now available on frontend</p></li>
<li><p>Fix bug in Python 3 queue adapter (thanks to F. Zapata)</p></li>
<li><p>Fix small bug in offline mode (G. Petretto)</p></li>
<li><p>Fix bug in frontend pagination (G. Petretto)</p></li>
<li><p>Improvements to wf.append (H. Rusche)</p></li>
</ul>
<p><strong>v1.2.2</strong></p>
<ul class="simple">
<li><p>Flask and webgui are installed by default (no additional pip install needed)</p></li>
<li><p>Fix small bug in squeue (thanks to M. Cahn for pointing it out)</p></li>
<li><p>webgui improvements, including view for workflow metadata queries (D. Winston)</p></li>
<li><p>remove display_wflows command and associated docs. It is unmaintained and the web GUI now plots WFs</p></li>
</ul>
<p><strong>v1.2.1</strong></p>
<ul class="simple">
<li><p>attempt to fix further pip install issues in v1.2.0</p></li>
</ul>
<p><strong>v1.2.0</strong></p>
<ul class="simple">
<li><p>attempt to fix pip install issues in v1.1.9</p></li>
</ul>
<p><strong>v1.1.9</strong></p>
<ul class="simple">
<li><p>Workflow graph displayed visually in “lpad webgui” (C. Harris)</p></li>
<li><p>Add ability to override queue commands (thanks to D. Waroquiers)</p></li>
<li><p>detect_unreserved should only detect reserved fws (G. Petretto)</p></li>
</ul>
<p><strong>v1.1.8</strong></p>
<ul class="simple">
<li><p>Some mods to adding a workflow to another workflow (thanks to H. Rusche & J. Montoya)</p></li>
<li><p>LaunchPad handles LockedWorkflowException (P. Huck)</p></li>
<li><p>prevent MSONable objects from being deserialized twice (thanks to J. Montoya)</p></li>
</ul>
<p><strong>v1.1.7</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>FWS now properly handles workflow states for <code class="docutils literal notranslate"><span class="pre">allow_fizzled_parents</span></code>. Run <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">admin</span> <span class="pre">refresh</span> <span class="pre">-s</span> <span class="pre">FIZZLED</span></code> to update your DB.</p>
</div>
<ul class="simple">
<li><p>fix WFLock causing inconsistent states in workflows; detect such cases in detect_lostruns; add –refresh as fix (G. Petretto)</p></li>
<li><p>add ability to introspect launches</p></li>
<li><p>fix for COMPLETED workflow state when <cite>_allow_fizzled_parents</cite> is True (D. Waroquiers, G. Petretto)</p></li>
<li><p>allow FWS users to use as_dict() instead of to_dict() if they prefer (psuedo-compatibility with MSONable)</p></li>
<li><p>add commas to counts in lpad GUI</p></li>
</ul>
<p><strong>v1.1.6</strong></p>
<ul class="simple">
<li><p>add beta of <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">introspect</span></code> (no docs yet)</p></li>
<li><p>fix <code class="docutils literal notranslate"><span class="pre">-q</span></code> option of <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">report</span></code> (D. Winston)</p></li>
</ul>
<p><strong>v1.1.5</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>FWS now decodes monty-style objects, e.g. pymatgen. If you encounter decoding issues, set DECODE_MONTY=False in your fw_config.</p>
</div>
<ul class="simple">
<li><p>completely reimplemented reporting (type <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">report</span></code> for an example)</p></li>
<li><p>both encode and decode for monty-style objects</p></li>
<li><p>safer require_password=False option</p></li>
<li><p>fix njobs for SLURM (P. Huck)</p></li>
<li><p>fix bug in remove_useless_dirs (G. Petretto)</p></li>
<li><p>fix bug in detect_lostruns (thanks to G. Petretto)</p></li>
<li><p>add QUEUE_JOBNAME_MAXLEN config parameter, i.e. maximum char length for job names sent to queueing systems (D. Waroquiers)</p></li>
</ul>
<p><strong>v1.1.4</strong></p>
<ul class="simple">
<li><p>added JS folder to pip install (should fix JSONview issues)</p></li>
<li><p>optional max param for track_fws command</p></li>
<li><p>performance updates</p></li>
<li><p>doc updates</p></li>
</ul>
<p><strong>v1.1.3</strong></p>
<ul class="simple">
<li><p>fix bug that caused FWorker queries to chain on themselves</p></li>
<li><p>fix issue of Python runners that override sys.stdout, causing problems in ScriptTask</p></li>
<li><p>fix unit tests</p></li>
</ul>
<p><strong>v1.1.2</strong></p>
<ul class="simple">
<li><p>new special keyword _add_launchpad_and_fw_id allows accessing the LaunchPad in the FireTask</p></li>
<li><p>new special keyword _pass_job_info makes it easy to pass run locations between jobs in a Workflow</p></li>
<li><p>new special keyword _preserve_fworker makes it easy to run multiple jobs on the same FWorker</p></li>
<li><p>default __repr__ for FWSerializable</p></li>
<li><p>fix Hopper qstat bug</p></li>
<li><p>Cobalt queue fixes (W. Scullin)</p></li>
<li><p>SLURM template update (P. Huck)</p></li>
</ul>
<p><strong>v1.1.1</strong></p>
<ul class="simple">
<li><p>greatly improve webgui: stability, clarity, functionality, and speed</p></li>
</ul>
<p><strong>v1.1.0</strong></p>
<ul class="simple">
<li><p>fix bug in created_on for workflows (thanks to W. Zhao for pointing it out)</p></li>
<li><p>fix bug in FWorker query for certain situations (P. Huck)</p></li>
<li><p>Updates for Cobalt, Py3 (W. Scullin)</p></li>
<li><p>Updates for IBM Loadsharing facility (Z. Ulissi)</p></li>
</ul>
<p><strong>v1.08</strong>
.. note:: v1.08 is not in pip due to version number issues, use Github to get this legacy version</p>
<ul class="simple">
<li><p>allow PyTask to return FWAction</p></li>
<li><p>allow FWConfig to set web host and port for GUI</p></li>
<li><p>make detect_lostruns more robust to failure halfway through</p></li>
<li><p>minor fixes and typo corrections (jakirkham)</p></li>
</ul>
<p><strong>v1.07</strong>
.. note:: v1.07 is not in pip due to version number issues, use Github to get this legacy version</p>
<ul class="simple">
<li><p>fix bug in offline mode</p></li>
</ul>
<p><strong>v1.06</strong>
.. note:: v1.06 is not in pip due to version number issues, use Github to get this legacy version
.. caution:: Offline mode unusable in this release</p>
<ul class="simple">
<li><p>Pymongo3 compatibility</p></li>
<li><p>fix double tab open on lpad webgui (G. Pettreto)</p></li>
<li><p>show FW WAITING state</p></li>
<li><p>unit test offline mode</p></li>
</ul>
<p><strong>v1.05</strong>
.. note:: v1.05 is not in pip due to version number issues, use Github to get this legacy version</p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The default behavior for PyTask handling of kwargs has changed. To maintain legacy behavior, update the “auto_kwargs” option to True in your FireTasks.</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>Offline mode unusable in this release</p>
</div>
<ul class="simple">
<li><p>Update PyTask kwargs handling (J. Kirkham)</p></li>
<li><p>Fix writing of FW.json files with _launch_dir param (G. Petretto)</p></li>
<li><p>update PBS template (K. Matthew)</p></li>
<li><p>minor fixes (J. Kirkham)</p></li>
</ul>
<p><strong>v1.04</strong></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>v1.00-v1.03 are skipped due to problems in pip installation</p>
</div>
<ul class="simple">
<li><p>fix non-default host/port on Flask site</p></li>
<li><p>remove base site (old frontend)</p></li>
<li><p>address installation issues (MANIFEST.in, package_data)</p></li>
<li><p>improve unit tests</p></li>
</ul>
<p><strong>v0.99</strong></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>v0.98 is skipped, as it has a faulty dependency.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Users of the frontend will need to install Flask, <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">flask;</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">flask-paginate</span></code>. Django is no longer required for the frontend.</p>
</div>
<ul class="simple">
<li><p>Ability to add FireWorks to existing workflow (launchpad.add_wf_to_fwids)</p></li>
<li><p>Better unit tests for task-level reruns (G. Petretto)</p></li>
<li><p>Redesigned web site using Flask (M. Brafman)</p></li>
</ul>
<p><strong>v0.97</strong></p>
<ul class="simple">
<li><p>Fix bug in adding multiple detours</p></li>
<li><p>Task-level reruns (G. Petretto)</p></li>
<li><p>Better Fworker default restrictions (G. Petretto)</p></li>
<li><p>Make _launch_dir if doesn’t exist (G. Petretto)</p></li>
<li><p>Bug fixes (G. Petretto)</p></li>
</ul>
<p><strong>v0.96</strong></p>
<ul class="simple">
<li><p>Address some installation issues (thanks to kpoman)</p></li>
<li><p>fix minor issues and docs</p></li>
</ul>
<p><strong>v0.95</strong></p>
<ul class="simple">
<li><p>Add decompressdir task (S.P. Ong)</p></li>
<li><p>Fix bugs in offline launch (G. Petretto)</p></li>
<li><p>Improve failure handling in case of FW system failure (G. Petretto)</p></li>
<li><p>Allow embedding error message on FW rerun (G. Petretto)</p></li>
<li><p>Minor testing improvements</p></li>
</ul>
<p><strong>v0.94</strong></p>
<ul class="simple">
<li><p>Improve performance of get_wflows (S.P. Ong)</p></li>
<li><p>Fix another bug due to performance improvements (B. Medasani)</p></li>
<li><p>Fix bug in de-serialization of non dict-like FireTasks and other serialization issues</p></li>
</ul>
<p><strong>v0.93</strong></p>
<ul class="simple">
<li><p>Fix bug in performance improvement cached state + unit tests (B. Medasani)</p></li>
<li><p>minor bug fixes, installation changes</p></li>
</ul>
<p>lpad
<strong>v0.92</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>This version has a minor bug affecting defusing of FWs and cached states for performance, fixed in v0.94</p>
</div>
<ul class="simple">
<li><p>Improve large workflow performance using a LazyFirework (B. Medasani, D. Gunter)</p></li>
<li><p>some code cleanups and minor (rare) bugfix to datetime</p></li>
<li><p>Add email option to PBS adapter (S.P. Ong)</p></li>
<li><p>Support for pymatgen as_dict formulation (X. Qu)</p></li>
</ul>
<p><strong>v0.91</strong></p>
<ul class="simple">
<li><p>Major: Rename FireWork to Firework. Should be fully backward-compatible for the moment, but users must switch by ~v1.0.</p></li>
<li><p>Unicode compatibility for Py3k (S.P. Ong)</p></li>
</ul>
<p><strong>v0.90</strong></p>
<ul class="simple">
<li><p>Introduce reporting tools via lpad report (W. Chen)</p></li>
<li><p>Fix bug in locking</p></li>
<li><p>Greatly speed up rlaunch rapidfire by removing artificial sleep</p></li>
<li><p>Use monty CLoader (S.P. Ong)</p></li>
</ul>
<p><strong>v0.89</strong></p>
<ul class="simple">
<li><p>Fix small FireTaskMeta issue (G. Petretto w/S.P. Ong)</p></li>
<li><p>simplify some imports</p></li>
<li><p>Add reservation display mode (S.P. Ong)</p></li>
<li><p>add updated_on to FW which updates whenever FW changes state</p></li>
<li><p>improve docs</p></li>
</ul>
<p><strong>v0.88</strong></p>
<ul class="simple">
<li><p>Add many more unit tests (B. Medasani)</p></li>
<li><p>Fix tracking when FireTask crashes (B. Medasani)</p></li>
<li><p>Clean up some logging</p></li>
<li><p>Don’t rerun DEFUSED FWs - they must be reignited</p></li>
<li><p>Allow defuse of COMPLETED FWs</p></li>
<li><p>minor internal fixes</p></li>
</ul>
<p><strong>v0.87</strong></p>
<ul class="simple">
<li><p>Fix major bug causing FIZZLED FWs to rerun spontaneously</p></li>
<li><p>Make WFLock more nimble</p></li>
<li><p>Forcibly remove WFLock after some time in case of catastrophe (tunable in FW_config)</p></li>
<li><p>improve unit tests</p></li>
</ul>
<p><strong>v0.86</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This version has a major bug that causes FIZZLED FWs to rerun, patched in v0.87</p>
</div>
<ul class="simple">
<li><p>add delete_wfs command (w/S.P. Ong)</p></li>
<li><p>add update_fws command (S.P. Ong)</p></li>
<li><p>add ignore_errors option in some default FireTasks (S.P. Ong)</p></li>
<li><p>fix bug in Windows $HOME var (thanks to A. Berg)</p></li>
<li><p>fig bug in reporting of lost FWs; rerun option should be OK in prev. versions</p></li>
<li><p>change FIZZLED to have lower STATE_RANK than READY/RESERVED/RUNNING/etc</p></li>
</ul>
<p><strong>v0.85</strong></p>
<ul class="simple">
<li><p>fix bug in running daemon mode locally with qlaunch rapidfire (B. Foster)</p></li>
<li><p>better handling of duplicate path detection (S.P. Ong)</p></li>
<li><p>add support for nodes keyword in SLURM adapter (S.P. Ong)</p></li>
</ul>
<p><strong>v0.84</strong></p>
<ul class="simple">
<li><p>ability to define links when defining FireWorks rather than all at the Workflow level (based on conversation with H. Rusche)</p></li>
<li><p>better handling of config files and better reporting on config file conflicts</p></li>
</ul>
<p><strong>v0.83</strong></p>
<ul class="simple">
<li><p>misc multiprocessing improvements (X. Qu)</p></li>
<li><p>better handling of dir creation conflicts (X. Qu)</p></li>
</ul>
<p><strong>v0.82</strong></p>
<ul class="simple">
<li><p>add ability to define links via {fw1:fw2} objects rather than explicit IDs (based on conversation with H. Rusche)</p></li>
<li><p>un-reserve a FW if queue submission goes badly and clean up queue launcher code</p></li>
<li><p>internal cleanups (don’t rerun ARCHIVED jobs, skip reruns of WAITING jobs)</p></li>
<li><p>stop rapidfire upon error in queue launch</p></li>
<li><p>rerun fw on unreserve</p></li>
<li><p>add methods to work with queue ids (<code class="docutils literal notranslate"><span class="pre">cancel_qid</span></code>, <code class="docutils literal notranslate"><span class="pre">--qid</span></code> option in <code class="docutils literal notranslate"><span class="pre">get_fws</span></code>, and <code class="docutils literal notranslate"><span class="pre">get_qid</span></code>)</p></li>
</ul>
<p><strong>v0.81</strong></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A major bugfix to dynamic and branching workflows was added in this release</p>
</div>
<ul class="simple">
<li><p>fix race condition bug in which two FW belonging to same WF simultaneously try to update the WF, and only one succeeds</p></li>
</ul>
<p><strong>v0.80</strong></p>
<ul class="simple">
<li><p>rerun duplicated FWs on a rerun command (enabled by default), and return back all fw_ids that were rerun</p></li>
<li><p>change default QUEUE_UPDATE_INTERVAL from 15 secs down to 5 secs</p></li>
<li><p>add background tuneup option, and make it the default</p></li>
<li><p>misc. cleanup (S.P. Ong)</p></li>
</ul>
<p><strong>v0.79</strong></p>
<ul class="simple">
<li><p>Add support for IBM LoadLeveler Queue (F. Brockherde)</p></li>
</ul>
<p><strong>v0.78</strong></p>
<ul class="simple">
<li><p>Fix spec copy bug as reported by Github user (F. Brockherde)</p></li>
<li><p>Misc fixes (archiving FWs, tuple support)</p></li>
</ul>
<p><strong>v0.77</strong></p>
<ul class="simple">
<li><p>Support/fix serialization of tuples as list instead of String (S.P. Ong)</p></li>
<li><p>Introduce fw_env variables (S.P. Ong)</p></li>
</ul>
<p><strong>v0.76</strong></p>
<ul class="simple">
<li><p>Better test for invalid WFs (S.P. Ong)</p></li>
<li><p>Minor internal code cleanup (S.P. Ong)</p></li>
<li><p>add internal profiling tools (D. Gunter)</p></li>
</ul>
<p><strong>v0.75</strong></p>
<ul class="simple">
<li><p>Fix bug that randomly affected some dynamic workflows</p></li>
<li><p>Add CompressDir and ArchiveDir tasks (S.P. Ong)</p></li>
<li><p>Initial commit of PyTask (S.P. Ong)</p></li>
<li><p>Initial networkx graphing of workflows via lpad (S.P. Ong)</p></li>
</ul>
<p><strong>v0.72</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This version has a bug that can affect some dynamic workflows, patched in v0.75</p>
</div>
<ul class="simple">
<li><p>Include default base site files in pip install</p></li>
<li><p>Optimizations for when WFs contains 1000s of root node FWs</p></li>
<li><p>zopen tracker files</p></li>
</ul>
<p><strong>v0.71</strong></p>
<ul class="simple">
<li><p>Include default templates in pip install</p></li>
<li><p>Change default formatting in get_wfs (S.P. Ong)</p></li>
</ul>
<section id="v0-7">
<h2>v0.7<a class="headerlink" href="#v0-7" title="Link to this heading">¶</a></h2>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The default behavior is now that mod_spec and update_spec push updates to next Firework AND the next FireTask</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The FWConfig parameters are no longer called via a FWConfig() class instantiation; you can import these parameters directly now.</p>
</div>
<ul class="simple">
<li><p>Python 3 support! via ‘six’ library (S.P. Ong)</p></li>
<li><p>BackgroundTasks introduced</p></li>
<li><p>Performance improvements to get_wf command (S.P. Ong)</p></li>
<li><p>Deserialization warnings and added stability (S.P. Ong)</p></li>
<li><p>Reservation mode and silencer works in remote launch (S.P. Ong)</p></li>
<li><p>Restore old FileTransferTask behavior</p></li>
<li><p>Tutorial updates</p></li>
<li><p>Various internal improvements, e.g. to FWConfig (S.P. Ong)</p></li>
<li><p>Bug fixes (A. Jain, S.P. Ong)</p></li>
</ul>
<p><strong>v0.66</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This version changes the default serialization for custom FireWorks without _fw_name to <project>::<Class> instead of <Class>. If you have custom FireTasks from v0.62-v0.65 that did not specify _fw_name explicitly, this introduces a backward incompatibility. Contact the support list if this affects you - an easy fix is available.</p>
</div>
<ul class="simple">
<li><p>Fix major bug in dynamic workflows with multiple additions/detours</p></li>
<li><p>Fixed lpad reset that became broken in recent release</p></li>
<li><p>Change default _fw_name for FireTasks to <project>::<Class>, e.g. fireworks::MyTask</p></li>
</ul>
<p><strong>v0.65</strong></p>
<ul class="simple">
<li><p>Fix bug in qlaunch singleshot introduced in previous release (S.P. Ong)</p></li>
<li><p>Add qlaunch cleanup (S.P. Ong)</p></li>
<li><p>Setup different default config dirs (S.P. Ong)</p></li>
</ul>
<p><strong>v0.64</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This version introduced a major bug in <code class="docutils literal notranslate"><span class="pre">qlaunch</span> <span class="pre">singleshot</span></code> via the command line (fixed in v0.65)</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This version introduced a bug in <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">reset</span></code> via the command line (fixed in v0.66)</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The <code class="docutils literal notranslate"><span class="pre">add_dir</span></code> command is incorporated into the <code class="docutils literal notranslate"><span class="pre">add</span></code> command. e.g. <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">add</span> <span class="pre">my_dir/*.yaml</span></code>. Many command line options that allowed comma-separated lists are now space-separated lists to better employ argparse (see updated docs).</p>
</div>
<ul class="simple">
<li><p>clean up argument parsing (S.P. Ong)</p></li>
<li><p>remote qlaunch handles multiple configs (S.P. Ong)</p></li>
</ul>
<p><strong>v0.63</strong></p>
<ul class="simple">
<li><p>fix bug in rtransfer mode of FileTransferTask (S.P. Ong)</p></li>
<li><p>improvements to remote qlaunch (S.P. Ong)</p></li>
</ul>
<p><strong>v0.62</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The TransferTask is renamed to FileTransferTask (however, existing FireWorks databases should be backwards-compatibile). The names of the default FireTasks no longer have spaces; however, existing FireWorks databases and code should be backwards-compatible.</p>
</div>
<ul class="simple">
<li><p>Add FIFO and FILO sort options for equal priority FireWorks</p></li>
<li><p>Remove database locks in multiprocessing mode</p></li>
<li><p>Allow multiple scripts in ScriptTask (S.P. Ong)</p></li>
<li><p>Add additional File I/O FireTasks (S.P. Ong)</p></li>
<li><p>Changes to FireTask base implementation (S.P. Ong)</p></li>
<li><p>Allow config file in $HOME/.fireworks (S.P. Ong)</p></li>
<li><p>Add remote options to qlaunch via fabric library (S.P. Ong)</p></li>
<li><p>_fw_name automatically set to class name if unspecified (S.P. Ong)</p></li>
<li><p>Remove ValueError upon not finding a Firework to run and handle this situation better</p></li>
</ul>
<p><strong>v0.61</strong></p>
<ul class="simple">
<li><p>Include text files needed for queue adapters in distribution (D. Gunter)</p></li>
</ul>
</section>
<section id="v0-6">
<h2>v0.6<a class="headerlink" href="#v0-6" title="Link to this heading">¶</a></h2>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The QueueAdapter code has been refactored in a way that is not fully backward compatible. Chances are, you will have to modify any <code class="docutils literal notranslate"><span class="pre">my_qadapter.yaml</span></code> files you have so that the <code class="docutils literal notranslate"><span class="pre">_fw_name</span></code> is set to <em>CommonAdapter</em> and a new <code class="docutils literal notranslate"><span class="pre">_fw_q_type</span></code> parameter is set to <em>PBS</em>, <em>SGE</em>, or <em>SLURM</em>.</p>
</div>
<ul class="simple">
<li><p>Major refactor of QueueAdapters so it is easy to change template files without adding new code (S.P. Ong)</p></li>
<li><p>restore lpad.maintain()</p></li>
<li><p>minor doc updates</p></li>
</ul>
<p><strong>v0.54</strong></p>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">--exclude</span></code> and <code class="docutils literal notranslate"><span class="pre">--include</span></code> options to Trackers + minor formatting changes</p></li>
<li><p>use config file in current dir if possible</p></li>
</ul>
<p><strong>v0.53</strong></p>
<ul class="simple">
<li><p>Display name in trackers</p></li>
<li><p>Fix some bugs relating to multiprocessing & offline mode (Xiaohui Qu)</p></li>
<li><p>Don’t require password when tracking many FWs</p></li>
<li><p>Default 25 lines in trackers</p></li>
</ul>
<p><strong>v0.52</strong></p>
<ul class="simple">
<li><p>add <em>trackers</em>, or the ability to monitor output files</p></li>
</ul>
<p><strong>v0.51</strong></p>
<ul class="simple">
<li><p>make set_priority work as intended through command line</p></li>
<li><p>invert the -b option on webgui (new -s option skips opening browser)</p></li>
</ul>
</section>
<section id="v0-5">
<h2>v0.5<a class="headerlink" href="#v0-5" title="Link to this heading">¶</a></h2>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The command/function <code class="docutils literal notranslate"><span class="pre">detect_fizzled</span></code> has changed to <code class="docutils literal notranslate"><span class="pre">detect_lostruns</span></code>, changed old arguments and added additional ones</p>
</div>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The command/function <code class="docutils literal notranslate"><span class="pre">detect_unreserved</span></code> has changed - refactored “mark” to “fizzle”</p>
</div>
<ul class="simple">
<li><p>add option to “rerun” when detecting lost runs</p></li>
<li><p>add option to only detect short-lived lost jobs (useful for job packing type failures)</p></li>
<li><p>refactored argument names and method names for clarity</p></li>
</ul>
<p><strong>v0.46</strong></p>
<ul class="simple">
<li><p>add NEWT queue adapter</p></li>
</ul>
<p><strong>v0.45</strong></p>
<ul class="simple">
<li><p>allow user to confirm database reset and multi-FW changes via an input prompt rather than password parameter</p></li>
</ul>
<p><strong>v0.44</strong></p>
<ul class="simple">
<li><p>make it easier to define new queueadapters, and add documentation</p></li>
</ul>
<p><strong>v0.43</strong></p>
<ul class="simple">
<li><p>fix bug introduced in v0.4 that caused rlaunch rapidfire to stop working</p></li>
</ul>
<p><strong>v0.42</strong></p>
<ul class="simple">
<li><p>fix bug introduced in v0.4 that caused update_time to be NULL for launches</p></li>
</ul>
<p><strong>v0.41</strong></p>
<ul class="simple">
<li><p>add <code class="docutils literal notranslate"><span class="pre">set_priority</span></code> function to LaunchPad</p></li>
<li><p>minor bug fixes related to multi-launcher and default queue params</p></li>
</ul>
</section>
<section id="v0-4">
<h2>v0.4<a class="headerlink" href="#v0-4" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>add offline mode</p></li>
</ul>
<p><strong>v0.37</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The default behavior in ScriptTask is now <code class="docutils literal notranslate"><span class="pre">fizzle_bad_rc</span></code>.</p>
</div>
<ul class="simple">
<li><p>add <code class="docutils literal notranslate"><span class="pre">lpad</span> <span class="pre">add_scripts</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fizzle_bad_rc</span></code> by default in ScriptTask</p></li>
<li><p>add FWorker() by default in rlaunch</p></li>
</ul>
<p><strong>v0.36</strong></p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>The <code class="docutils literal notranslate"><span class="pre">rerun_fw</span></code>, <code class="docutils literal notranslate"><span class="pre">defuse_fw</span></code>, and <code class="docutils literal notranslate"><span class="pre">reignite_fw</span></code> commands are now pluralized, <code class="docutils literal notranslate"><span class="pre">refresh_wf</span></code> is simply <code class="docutils literal notranslate"><span class="pre">refresh</span></code>, and <code class="docutils literal notranslate"><span class="pre">rerun_fizzled</span></code> has been incorporated into <code class="docutils literal notranslate"><span class="pre">rerun_fws</span></code>.</p>
</div>
<ul class="simple">
<li><p>much more powerful control for <code class="docutils literal notranslate"><span class="pre">rerun_fws</span></code>, <code class="docutils literal notranslate"><span class="pre">defuse</span></code>, <code class="docutils literal notranslate"><span class="pre">archive</span></code>, <code class="docutils literal notranslate"><span class="pre">reignite</span></code>, <code class="docutils literal notranslate"><span class="pre">defuse_fws</span></code>, <code class="docutils literal notranslate"><span class="pre">reignite_fws</span></code>, <code class="docutils literal notranslate"><span class="pre">refresh</span></code>.</p></li>