-
Notifications
You must be signed in to change notification settings - Fork 6
/
changelog2.json
4661 lines (4660 loc) · 275 KB
/
changelog2.json
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
{
"versions": [
{
"tag": "v4.6.2",
"date": "11/18/2024",
"items": [
{
"tag": "update",
"description": "CryoSPARC worker processes now request that the OS not allocate transparent hugepages during memory allocations. This change improves performance and stability significantly, especially on nodes with multiple GPUs and multiple simultaneous jobs. Jobs will also emit a warning if the OS is set to always use transparent hugepages."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-check-for-corrupt-particles\">Job: Check for Corrupt Particles</a> now checks for NaN values by default, and fails (rather than completing with warnings) if any corrupt files are detected. The job can then be <a href=\"https://guide.cryosparc.com/guides-for-v3.3/user-interface-and-usage-guide/queue-job-inspect-job-and-other-job-actions#mark-job-as-complete\">marked as completed</a> or re-run with the “Fail if corruption is detected” parameter turned off in order to use the output in which corrupt files have been filtered out. The job can also check MRC header checksums."
},
{
"tag": "update",
"description": "CryoSPARC now performs an explicit NaN values check when writing MRC files, and also writes a checksum to the MRC header for subsequent corruption detection."
},
{
"tag": "update",
"description": "2D classification jobs now request an appropriate number of CPUs when running on more than one GPU."
},
{
"tag": "update",
"description": "The SSD cache system is now more robust on cluster filesystems, and “File not found” errors during caching should no longer occur. The system also produces additional logs and diagnostics."
},
{
"tag": "fixed",
"description": "When the random seed parameter is manually overridden, 2D/3D classification and refinement jobs now correctly use the provided value and produce similar results when repeated, up to GPU floating-point determinism and precision."
},
{
"tag": "fixed",
"description": "Fixed a variety of rare edge cases that could cause issues in the high performance I/O system that was introduced in v4.6."
},
{
"tag": "fixed",
"description": "The default limit of open file descriptors is increased to avoid issues on some OSes."
},
{
"tag": "fixed",
"description": "Falcon C EER files no longer fail to import."
},
{
"tag": "fixed",
"description": "Resolved an issue were the application server could crash if a file was incorrectly deleted."
},
{
"tag": "fixed",
"description": "Resolved an issue where the volume viewer display of local resolution colour maps was flipped along the Z axis."
},
{
"tag": "fixed",
"description": "Resolved an issue where the volume viewer could display a stale volume result after clearing and re-running a job in some scenarios."
},
{
"tag": "fixed",
"description": "Resolved an issue where jobs with blueprints would always display in the job builder regardless of which filter tag was applied."
},
{
"tag": "fixed",
"description": "Resolved an issue in the cards view where job cards could appear blank when expanding a group in a workspace with a significant number of large groups clustered closely together."
},
{
"tag": "fixed",
"description": "Fixed an issue where loading 3DFlex mesh segmentation files in MRC format would fail due to an off-by-one error."
}
]
},
{
"tag": "v4.6.0",
"date": "09/10/2024",
"items": [
{
"tag": "note",
"description": "Support for CentOS Linux 7 operating system is deprecated. CryoSPARC v4.6 will continue to function on CentOS 7, but future versions will no longer support this operating system. CentOS Linux 7 <a href=\"https://www.redhat.com/en/blog/centos-linux-has-reached-its-end-life-eol\">reached end of life on June 30, 2024</a>."
},
{
"tag": "new",
"description": "Up to <b>2.1x speedup</b> across refinement and classification jobs due to a redesign of CryoSPARC’s I/O system that provides significant optimizations to particle read times. In v4.6.0, a homogeneous refinement of 2.3M particles with box size 300 can now be completed in just 27 minutes."
},
{
"tag": "new",
"description": "Rebuilt <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/job-views-cards-tree-and-table\">tree, card, and table views</a> for jobs, with significant performance optimizations to support large workspaces and projects. Up to <strong>10x faster</strong> initial load time for the tree view, and subsequent updates when connecting and creating jobs are nearly instantaneous. In the card and table views, all jobs are now instantly accessible with detailed information loading progressively as you scroll."
},
{
"tag": "new",
"description": "Job Groups: collapse multiple jobs into a single card to maintain legibility and easy navigation within a workspace. Job Groups work across the tree, card and table views, and jobs can be easily added and removed from groups using multi-selection and the right-click menu. <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/job-views-cards-tree-and-table#job-groups\">Learn more</a>"
},
{
"tag": "new",
"description": "Improved navigation: the job search menu and targeting system allow you to quickly find and automatically navigate to any particular job, or quickly jump to the latest created, completed, or running job."
},
{
"tag": "new",
"description": "Inspect Particle Picks now has a parameter called “<a href=\"https://guide.cryosparc.com/application-guide-v4.0+/interactive-jobs#auto-clustering\">Auto cluster</a>”, which clusters particles based on their NCC and power scores, and can automatically select a cluster that will ideally contain true particle picks based on those scores. This allows Inspect Particle Picks to be run without user intervention. Auto cluster is designed to be used with denoised micrographs from the Micrograph Denoiser job."
},
{
"tag": "update",
"description": "The <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/upload-local-files\">local file upload tool</a> now supports <code>.seg</code> segmentation files."
},
{
"tag": "update",
"description": "Labels designate type of output when downloading results from the job preview dialog output groups panel (e.g., map, mask, etc.)."
},
{
"tag": "update",
"description": "Added the ability to mark or unmark a job as final from the job sidebar actions panel. Read more about data cleanup in this <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-data-cleanup-v4.3+\">guide</a>."
},
{
"tag": "update",
"description": "Added ability to sort projects, workspaces, and sessions by their titles."
},
{
"tag": "update",
"description": "Added filter bar toggles to the projects view to quickly show and hide archived and/or detached projects."
},
{
"tag": "update",
"description": "Archived and detached project filters are now additive, and can be toggled together to show both archived and detached projects, instead of just archived or detached projects."
},
{
"tag": "update",
"description": "Introduced a quick action to create Homogeneous Reconstruction Only from an Import Particle Stack job."
},
{
"tag": "update",
"description": "Unused particles will be connected when building a Homogeneous Refinement, Non-uniform Refinement or Heterogeneous Refinement from a quick action on Ab-inito."
},
{
"tag": "update",
"description": "Introduced a quick action to build a Blob Picker Tuner job from Inspect Particle Picks."
},
{
"tag": "update",
"description": "Added completed, failed or killed timing to the tooltip that displays when viewing the elapsed time of a job on the card."
},
{
"tag": "update",
"description": "Downloading a CSV of projects, workspaces, sessions and jobs will include relevant project or workspace ID and a timestamp representing when the list was generated."
},
{
"tag": "update",
"description": "Cluster configuration variables are now listed in ascending alphabetical order."
},
{
"tag": "update",
"description": "Various improvements to job informational tags: Support for Homogeneous and Heterogeneous Reconstruct Only jobs, Streaming Homogeneous Refinement, and symmetry relaxation parameters."
},
{
"tag": "update",
"description": "The Live Session data management tab is now deprecated and as such, a notice displays within the tab. It is recommended to perform <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-data-cleanup-v4.3+#live-session-compaction-and-restoration\">Live Session compaction or restoration</a> as a more robust way to compress, archive and restore sessions."
},
{
"tag": "fixed",
"description": "Resolved an issue where exposure pixel size shown in the Live session sidebar would not account for EER upsampling."
},
{
"tag": "fixed",
"description": "Reduced memory usage and lower likelihood of out-of-memory errors during data clean-up operations, job input loading and job output result saving."
},
{
"tag": "fixed",
"description": "Deep Picker Train and Deep Picker Inference jobs are now restricted in workflows, and are only allowed if they do not include any child jobs inside of the workflow."
},
{
"tag": "fixed",
"description": "Clicking the job’s workspace in the details panel will no longer reset the current view to cards view."
},
{
"tag": "fixed",
"description": "Fixed an issue where the custom parameters tooltip in the job card’s footer would continue to be hidden even after queuing a job."
},
{
"tag": "fixed",
"description": "Fixed issue where some workspaces were not being sorted into the correct order when sorting by job count."
},
{
"tag": "fixed",
"description": "Fixed issue where job CSV downloads were using the job’s created at timestamp to populate the “Status Updated” field."
},
{
"tag": "fixed",
"description": "Resolved a case where filesystem errors could case the web application server to crash when downloading job results."
},
{
"tag": "fixed",
"description": "Resolved an issue where refinements with downstream <em>Local Resolution Estimation</em> jobs did not have an option to load a colour map within the volume viewer tab."
},
{
"tag": "fixed",
"description": "Resolved an issue in the job report PDF where parameters set to false were reported as ‘Not Set’. Instead, boolean parameters are now listed as ‘True’ or ‘False’."
},
{
"tag": "fixed",
"description": "Denoised micrographs will now be correctly scaled to the canvas and line up with pick locations when downloaded from the exposure viewer."
},
{
"tag": "fixed",
"description": "Resolved an issue where jobs queued from the sidebar would sometimes show a perpetual loading indicator until deselected."
}
]
},
{
"tag": "v4.5.3+240807 (Patch)",
"date": "08/08/2024",
"items": [
{
"tag": "fixed",
"description": "The <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/inspecting-data#volumes\">volume viewer</a> now has improved reliability, with reduced likelihood of issues when multiple large volumes are loaded."
},
{
"tag": "fixed",
"description": "Streaming refinement in CryoSPARC Live now re-scales a provided input volume and mask to match the extent and pixel size of the extracted particles."
},
{
"tag": "update",
"description": "Reference Based Motion Correction no longer fails with an error indicating that there are micrographs with fewer than 2 particles, when particle re-centering is turned on."
},
{
"tag": "update",
"description": "Import Result Group job no longer fails when importing a result containing a Topaz model."
},
{
"tag": "update",
"description": "Fixed a bug that caused the 3D Flex Generator job to run out of GPU memory for large datasets."
},
{
"tag": "update",
"description": "Ab-initio Reconstruction no longer fails when upstream particles have <code>alignments3D</code> metadata attached, and the number of particles parameter is set."
},
{
"tag": "update",
"description": "Fixed a bug that would cause the 3D Classification job to fail when class re-ordering was on, and the number of classes exceeded 12."
},
{
"tag": "update",
"description": "Orientation Diagnostics no longer fails when using imported half-maps."
},
{
"tag": "update",
"description": "Removed unnecessary SSD requirement in the Regroup 3D job."
},
{
"tag": "update",
"description": "Removed unused parameter “Recenter templates” from the Blob Picker job."
}
]
},
{
"tag": "v4.5.3",
"date": "06/04/2024",
"items": [
{
"tag": "new",
"description": "Check for Corrupt Micrographs job tests for and separates micrograph files that cannot be successfully read from disk."
},
{
"tag": "fixed",
"description": "Refinement jobs default parameters have been changed so that the jobs use the half-set split from the input particles by default. This ensures that repeated application of Reference Based Motion Correction and refinement does not cause mixing of the half-sets. The Particle Sets Tool job also now has an option to balance unequal half-set splits."
},
{
"tag": "fixed",
"description": "Orientation Diagnostics no longer fails on CPU-only worker nodes, and requests the correct number of CPUs when launching on a cluster."
},
{
"tag": "fixed",
"description": "Relative signal plots in Orientation Diagnostics jobs are now less crowded."
},
{
"tag": "fixed",
"description": "The Topaz Extract job now allows input in units of estimated particle diameter for the radius of extracted region parameter."
},
{
"tag": "fixed",
"description": "Import Result Group no longer fails to import exposures when some paths are missing."
},
{
"tag": "fixed",
"description": "Regroup 3D no longer outputs incorrect particles when classes are manually excluded."
},
{
"tag": "fixed",
"description": "Fixed an issue where for some large CryoSPARC Live sessions, scrolling through the exposure feed to earlier exposures could sometimes cause the application server to crash with a memory leak."
},
{
"tag": "fixed",
"description": "Excess UserWarnings are no longer printed in job log output."
},
{
"tag": "fixed",
"description": "The default value for <code>CRYOSPARC_JOB_LAUNCH_TIMEOUT</code> is now extended to 60 seconds."
}
]
},
{
"tag": "v4.5.1",
"date": "05/08/2024",
"items": [
{
"tag": "fixed",
"description": "Micrograph Denoiser no longer fails on launch due to <code>PicklingError</code>"
},
{
"tag": "fixed",
"description": "Scale bars on the Import Movies job card are now the correct size"
},
{
"tag": "fixed",
"description": "Gracefully handle missing chunks when attempting to save a file to the uploads directory via the local upload tool"
}
]
},
{
"tag": "v4.5.0",
"date": "05/07/2024",
"items": [
{
"tag": "new",
"description": "<p><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/exposure-curation/job-micrograph-denoiser\">Micrograph Denoiser (BETA)</a> job produces enhanced contrast in micrograph images to aid particle picking and visual inspection.</p><ul><li>→ Micrograph Denoiser uses a neural network model that can be trained on as few as 100 exposures from a new dataset in just a few minutes on a single GPU. The trained denoiser can then be used on new micrographs from the same or a different dataset. A pre-trained general denoiser model is also available to use without any training required.</li><li>→ The denoiser model is designed to work across a wide range of defocus and contrast levels.</li><li>→ Denoised micrographs can be used seamlessly in blob and template picking jobs, and can substantially improve picking results. Denoised micrographs also show by default in all interactive jobs, making visual inspection of micrographs easy.</li></ul>"
},
{
"tag": "new",
"description": "<p>Automatic selection of 2D classes or 3D classes given a 3D reference is now possible using new <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/particle-curation/reference-based-auto-select-2d\">Reference Based Auto Select 2D (BETA)</a> and <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-reference-based-automatic-select-3d-beta\">Reference Based Auto Select 3D (BETA)</a> jobs.</p><ul><li>→ These jobs align and compare classes to the reference volume and select classes either based on score thresholds or clustering.</li><li>→ The jobs can be set up once on a dataset, and can subsequently allow one-click automated processing on new similar datasets using <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/workflows\">Workflows</a>.</li><li>→ The jobs also make it easy to sort and select from hundreds of 2D classes or dozens 3D classes in datasets with substantial heterogeneity.</li></ul>"
},
{
"tag": "new",
"description": "Upload files from your local computer to the CryoSPARC system directly in the browser. This new ability streamlines workflows involving local visualization and editing of files such as 3D maps or masks. Uploaded files are saved to the selected project directory and can be imported and used in jobs. <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/upload-local-files\">Read more in the guide.</a>"
},
{
"tag": "new",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-orientation-diagnostics\">Orientation Diagnostics</a> job now reports <em>Relative Signal</em> — a new diagnostic that can help directly identify underrepresented views that affect map quality and the cFAR score. Relative signal is computed by considering FSCs within toroidal sections of Fourier half-maps to relate 3D signal quality to viewing direction. Two new plots are produced that show where on the viewing sphere relative signal is attenuated, with sample projections and an embedded structure to simplify interpretation."
},
{
"tag": "new",
"description": "New <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/particle-curation/job-rebalance-orientations\">Rebalance Orientations</a> job removes particles from overpopulated viewing direction regions. Rebalancing viewing directions can improve downstream refinements when particles have a highly non-uniform orientation distribution."
},
{
"tag": "new",
"description": "Jobs that produce multiple 3D volumes (such as 3D classification, Heterogeneous Refinement, 3D Variability Display, etc.) now output a <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/split-volumes-group\">“Volumes group” output</a> that contains multiple volumes, and can be connected to a downstream job with a single input connection. This enables seamless handling of arbitrary numbers of 3D volumes and automation using Workflows."
},
{
"tag": "new",
"description": "<p><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-align-3d-maps\">Align 3D Maps</a> has been reimplemented with a new 3D alignment method to increase the robustness and precision of volume-to-volume alignment. In addition, it can now:</p><ul><li>→ update particle alignments while searching over handedness,</li><li>→ transform all maps and masks associated with an input volume slot,</li><li>→ and accept inputs of different box and pixel sizes.</li></ul>"
},
{
"tag": "new",
"description": "The file browser now features an expandable sidebar to search and navigate into project directories. Bookmark commonly-accessed directories, making them available for access at a later time through the sidebar. <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/using-the-cryosparc-interface/file-browser\">Read more in the guide."
},
{
"tag": "new",
"description": "<a href=\"https://guide.cryosparc.com/application-guide-v4.0+/inspecting-data#inputs-and-parameters\">Improved ‘Inputs and Parameters’ tab</a> for jobs now displays additional input group information in a summarized view while retaining an option to view low-level connection details. By default only custom parameters are shown, making it easier to identify which parameters were set for a particular job."
},
{
"tag": "new",
"description": "Additional info tags now display on the job card with useful stats and summary data, for more jobs including Import Volumes, Exposure Curation, Exposure Sets Tool, and Helical Refinement. New <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/creating-and-running-jobs#job-quick-actions\">quick actions</a> allow quick creation and connection of many more job types in typical workflows."
},
{
"tag": "new",
"description": "The details section of the <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/inspecting-data#related-jobs\">job sidebar</a> now displays a more comprehensive summary of parents, children, and cloned jobs when hovered, including job type, status, summary stats, and custom parameters."
},
{
"tag": "update",
"description": "Support has been added for Falcon C camera <code>.eer</code> movies (2k x 2k physical pixels)."
},
{
"tag": "update",
"description": "<p>Various updates to <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/workflows\">Workflows</a>:</p><ul><li>→ New rebuilding system allows retaining annotations and settings when updating an existing Workflow.</li><li>→ Workflows can now be applied from anywhere in the application by selecting or creating a project and workspace from within the Workflow apply dialog.</li><li>→ Filter controls have been added to allow collapsing/expanding all jobs in sidebar, filtering by flagged jobs, and navigating to a selected job.</li><li>→ Fork option has been replaced with a “Create New” option in the edit dialog for simplicity and clarity.</li></ul>"
},
{
"tag": "update",
"description": "<p>Various improvements to <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta\">Reference Based Motion Correction (BETA)</a>:</p><ul><li>→ Input particles are now re-centred based on their aligned shifts, at the start of the job. This feature can be switched off. The upsampling factor for <code>.eer</code> movies can now be overridden.</li><li>→ The job has been improved to be significantly more stable. An option has been added to prevent crashing if the input movies contain different frame counts (the option is off by default). This option relies on the assumption that the most common frame count is “correct”, and will discard movies that don’t match that frame count. The job also no longer terminates if the distances between particles results in a singular covariance matrix, as a pseudo-inversion is now used. The chance of getting NaN values in the highest-frequency column of the FCC plot (due to low signal near the FSC cut-off frequency) has been greatly reduced. The job also no longer crashes if the upstream motion correction skipped the movie’s first frame.</li><li>→ The job now outputs movies or particles that were rejected, as separate output groups. Trajectory plots now correctly reflect the micrograph’s aspect ratio. The <code>mask_refine</code> low-level input is now optional (a mask must be supplied, but if the separate static mask connection is used, <code>mask_refine</code> need not be present).</li><li>→ It is now possible to prevent the GPU responsible for generating 2D reference projections from also computing trajectory estimates. Using this option reduces VRAM consumption but requires the use of at least 2 GPUs.</li></ul>"
},
{
"tag": "update",
"description": "Refinement jobs now produce a <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-orientation-diagnostics#plot-explanations\">cFSC summary plot</a> at every iteration, enabling anisotropy tracking throughout optimization (this includes homogeneous, non-uniform, helical, and local refinement). A new fast GPU-based implementation of the core cFSC computation adds minimal overhead, requiring less than a second of additional compute time for typical box sizes."
},
{
"tag": "update",
"description": "<p>Several improvements to <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-3d-classification-beta\">3D Classification</a>:</p><ul><li>→ In line with 3D Variability Analysis, the ‘Target Resolution’ parameter has been renamed to ‘Filter Resolution’ and must be explicitly set for the job to run. Also, the secondary RMS-based convergence criterion is now turned on by default. This secondary criterion can significantly reduce run times without substantially affecting the final class volumes.</li><li>→The job now includes particle pre-processing and symmetry enforcement, and class re-ordering is now turned off by default to avoid potential confusion.</li><li>→ The job tile figure is now revamped to show class ids, relative populations, and a more distinctive difference-from-consensus projection for each class.</li></ul>"
},
{
"tag": "update",
"description": "In <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/extraction/job-downsample-particles\">Downsample Particles</a>, users can now specify the desired approximate pixel size after Fourier-cropping, instead of specifying the Fourier-crop box size directly, if desired."
},
{
"tag": "update",
"description": "The <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-3d-flexible-refinement-3dflex-beta\">3D Flex Generator (BETA)</a> latent space plot is now coloured according to the normalized difference in 3D deformation relative to the origin. Larger values indicate regions of the latent space that encode more substantial flexing of the particle."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-regroup-3d\">Regroup 3D</a> now allows for pairwise alignment of volumes prior to regrouping, as well as alignment of volumes within a superclass after regrouping. It also now allows regrouping of all volumes into one single superclass."
},
{
"tag": "update",
"description": "The <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/interactive-jobs#interactive-job-manual-picker\">Manual Picker</a> interactive job now writes manually picked particle locations to disk every 10 seconds, to minimize data loss in case the job crashes."
},
{
"tag": "update",
"description": "The new and more reliable SSD cache system introduced in v4.4 is now enabled by default. It also now features a configurable distributed locking strategy to use when multiple running jobs access the SSD cache simultaneously; the default strategy is best in most cases, but use the <code>master</code> strategy for caches on distributed file systems such as GPFS and BeeGFS where POSIX locks are disabled or unavailable. <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring/environment-variables#cryosparc_worker-config.sh\">See guide for details</a>."
},
{
"tag": "update",
"description": "Deleting a project now completely removes the project folder on disk instead of leaving an empty folder."
},
{
"tag": "update",
"description": "Archived projects can now be deleted. Deleting an archived project will clear any remaining database references to the project and should clear up more space on disk. A deleted archived project cannot be un-archived. For more details about archiving, see the <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-data-management-in-cryosparc-v4.0+\">Data Management Guide</a>."
},
{
"tag": "update",
"description": "Projects that are archived, detached, or deleted can no longer be shared with other users."
},
{
"tag": "update",
"description": "Reduced default RAM requirements for some utility jobs."
},
{
"tag": "update",
"description": "Jobs will provide a warning before starting if the amount of RAM available is less than the amount of RAM requested by the job."
},
{
"tag": "update",
"description": "Jobs will no longer fail on completion if they cannot generate their passthrough outputs properly. They will instead raise a warning and continue to completion with potentially missing passthroughs."
},
{
"tag": "update",
"description": "Running <a href=\"https://guide.cryosparc.com/live/new-live-session-start-to-finish-guide#export-exposures-and-or-particles\">Export Exposures</a> from CryoSPARC Live sessions now provides additional information about curation thresholds that were set in the session."
},
{
"tag": "update",
"description": "When <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-maintenance-mode-and-configurable-user-facing-messages\">maintenance mode</a> is active, a banner will display in the header when viewing CryoSPARC Live sessions communicating to users that additional jobs or sessions will not be queued."
},
{
"tag": "update",
"description": "Ability to specify an arbitrary number of pre-processing GPU workers for a CryoSPARC Live session."
},
{
"tag": "update",
"description": "The <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/interactive-jobs#exposure-card-view\">Curate Exposures</a> interactive job can now load micrograph thumbnails that were generated in CryoSPARC Live."
},
{
"tag": "update",
"description": "Imports in <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/import/job-import-3d-volumes\">Import 3D Volumes</a> are now sorted alphabetically."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-volume-tools\">Volume Tools</a> now reports the centre of mass of the input volume, if it is a mask."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-volume-alignment-tools\">Volume Alignment Tools</a> now has the option to automatically re-centre the input volume and particles based on the centre of mass of the supplied mask, especially useful for local refinements."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/local-refinement/job-new-local-refinement-beta\">Local Refinement’s</a> fulcrum coordinates and <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-volume-alignment-tools\">Volume Alignment Tools</a>’ 3D centre coordinates now can be specified with units of pixels (px) or Angstroms (A)."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-volume-alignment-tools\">Volume Alignment Tools</a>’ 3D rotation angles can now be specified with units of radians (rad) or degrees (deg)."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/particle-curation/job-class-probability-filter\">Class Probability Filter</a> now supports the new <code>alignments3D_multi</code> particle field."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/particle-curation/job-rebalance-2d-classes-beta\">Rebalance 2D Classes</a> now always produces a “Particles Selected” output, containing selected particles from all of the superclasses."
},
{
"tag": "update",
"description": "Added parameters <code>Use spherical mask</code>, <code>Spherical mask diameter (A)</code>, and <code>Spherical mask diameter outer (A)</code> to allow users to customize the spherical mask used in <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/3d-refinement/job-heterogeneous-refinement\">Heterogenous Refinement</a>. The default behaviour is still the same."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-orientation-diagnostics\">Orientation Diagnostics</a> will now use the <code>mask_fsc_auto</code> mask present within the input volume connection, if no separate mask input has been connected."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-3d-flexible-refinement-3dflex-beta\">3D Flex Generator</a> now outputs a <code>JXX_particle_flows.npy</code> file that saves the trained mesh deformation (flow) of each particle."
},
{
"tag": "update",
"description": "New <code>Freeze latents during training</code> parameter in the <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-3d-flexible-refinement-3dflex-beta\">3D Flex Training</a> job allows 3D Flex to better preserve the 3DVA motions when trained from 3DVA latents."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/application-guide-v4.0+/interactive-jobs#interactive-job-inspect-particle-picks\">Inspect Particle Picks</a> now shows the picking statistics histogram in the job’s event log when the job completes, including a border showing the selected thresholds."
},
{
"tag": "update",
"description": "The exposure viewer in interactive jobs and CryoSPARC Live always pans when holding down the middle-mouse button, enabling navigation around the exposure while performing an action such as manual picking or measurement."
},
{
"tag": "update",
"description": "Refinements with global pose search now throw warnings if symmetry expanded particles are connected."
},
{
"tag": "update",
"description": "Reduced default workers and threads parameters for <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/deep-picking/topaz\">Topaz Preprocessing job</a>."
},
{
"tag": "update",
"description": "Correctly set CPU resource requirements for <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/deep-picking/topaz\">Topaz</a> jobs based on number of CPUs and number of workers specified in parameters."
},
{
"tag": "update",
"description": "Added a <code>Downsampling mode</code> parameter to <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/deep-picking/topaz\">Topaz</a> jobs with options of “manual” or “auto”. If set to manual, the user enters <code>Downsampling factor</code> as before. The default is now auto, where the user enters <code>Estimated particle diameter (A)</code> and the downsampling factor will be automatically calculated based on the type of model used."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/ctf-refinement/job-exposure-group-utilities\">Exposure Group Utilities</a> in “cluster&split” mode now respects the “Starting Exposure Group ID” parameter."
},
{
"tag": "update",
"description": "New <code>cluster_vars</code> argument for <code>Job.queue</code> method for queueing to clusters."
},
{
"tag": "update",
"description": "Allow copy or symbolic link operations in project directories for files outside the project."
},
{
"tag": "update",
"description": "Replaced the \"Output F-crop factor\" parameter in Reference Based Motion Correction with the ability to directly specify the desired output box size."
},
{
"tag": "fixed",
"description": "Previously, refinement jobs recorded internal runtime summary statistics in the database at every iteration. Stats from intermediate iterations are unnecessary and are no longer generated, and existing intermediate stats in the database will be removed in a migration upon updating to v4.5. We expect this change to noticeably improve performance in the web app when viewing or interacting with jobs due to the removed data’s size."
},
{
"tag": "fixed",
"description": "Repetitive warning messages from libtiff during normal reading of .eer movies have been suppressed, reducing the size of the job log."
},
{
"tag": "fixed",
"description": "Fixed a bug where ab-initio volumes could not be deselected after being selected in CryoSPARC Live sessions."
},
{
"tag": "fixed",
"description": "Fixed an issue where it was possible to detach projects that still had jobs queued in the scheduler."
},
{
"tag": "fixed",
"description": "Fixed a bug that could cause motion correction and CTF estimation jobs to freeze forever if a child process terminates abnormally."
},
{
"tag": "fixed",
"description": "Prevent applying previously-downloaded patches that don’t apply to the current version of CryoSPARC."
},
{
"tag": "fixed",
"description": "Fixed issue where thumbnails for Import Movies might not zoom in properly"
},
{
"tag": "fixed",
"description": "Fixed a bug introduced in v4.4 that would cause Patch Motion Correction jobs to fail if cleared and re-run, due to the missing input for empirical dose weights."
},
{
"tag": "fixed",
"description": "Patch Motion Correction now correctly updates the frame count in exposure metadata, in case it was recorded incorrectly by the import job (e.g. if “skip header check” was used). This will help Reference Based Motion Correction to pre-screen its input movies for those with mismatched frame counts, potentially averting a crash."
},
{
"tag": "fixed",
"description": "Allow using Job Cart with Reference Based Motion Correction."
},
{
"tag": "fixed",
"description": "Fixed issue which could cause Local Motion Correction to crash at the end of the job while computing summary statistics, on an otherwise successful run."
},
{
"tag": "fixed",
"description": "Fixed issue where particle diameter was not being calculated correctly in Manually Curate Exposures jobs with connected particle inputs."
},
{
"tag": "fixed",
"description": "Resolved a bug in Inspect Particle Picks where particle picks from denoised micrographs would report NCC scores outside of [0,1], causing them to be inaccessible to filter."
},
{
"tag": "fixed",
"description": "Fixed a bug in 2D Classification where if hard classification is enabled, particles would be assigned posterior scores of 0, causing particle counts to be incorrect in Select 2D and subsequent jobs."
},
{
"tag": "fixed",
"description": "Added override parameter for micrograph pixel size in 2D Classification to fix an issue where duplicate particle removal used the wrong micrograph pixel size on particle datasets from before version 4.5."
},
{
"tag": "fixed",
"description": "Fixed 2D Classification plots to be consistent with Select 2D Classes job."
},
{
"tag": "fixed",
"description": "Fixed an issue in Helical Refinement where input scales were previously reset to 0 if greyscale estimation is disabled."
},
{
"tag": "fixed",
"description": "Fixed plotting bug in 3D Classification which resulted in the focus mask being shifted from its true location by one pixel along each axis."
},
{
"tag": "fixed",
"description": "Global CTF Refinement now throws an explicit error when the maximum and minimum fit resolutions are incompatible."
},
{
"tag": "fixed",
"description": "If inconsistent aberration values within a single exposure group are found, refinements with global CTF refinement enabled now fail at the start of the job, rather than midway through."
},
{
"tag": "fixed",
"description": "Fixed bug that would prevent 3D Variability Display from skipping reconstruction in cluster mode."
},
{
"tag": "fixed",
"description": "Removed the download PDF option for cluster plots in 3D Variability; the PDFs take a long time to open due to the large number of points being plotted."
},
{
"tag": "fixed",
"description": "Fixed an issue in which <code>.seg</code>-format 3DFlex mesh segmentation files with certain topologies would fail."
},
{
"tag": "fixed",
"description": "Fixed an issue in which <code>.mrc</code>-format 3DFlex mesh segmentation files skipped the first segment."
},
{
"tag": "fixed",
"description": "Particle Sets Tool now correctly uses both a particle’s file path <em>and</em> its index within the file to identify matches when intersecting by path."
},
{
"tag": "fixed",
"description": "Fixed an issue where Symmetry Expansion and Volume Alignment Tools would ignore any additional particle blob slots (including those produced by Flex Data Prep, such as <code>blob_train</code>)."
},
{
"tag": "fixed",
"description": "In Simulate Data, fix to computation of the additive noise variance. The added noise no longer erroneously depends on the chosen CTF parameters."
},
{
"tag": "fixed",
"description": "SSD cache system no longer fails when some input particle files are symbolic links that resolve to the same file."
},
{
"tag": "fixed",
"description": "Prevent invalid multi-instance access when the environment of one instance is active while running <code>cryosparcm</code> commands for another."
},
{
"tag": "fixed",
"description": "Fixed a bug which caused the Gctf wrapper job to fail if <code>LD_LIBRARY_PATH</code> was unset."
},
{
"tag": "fixed",
"description": "Normalize project directory names when creating or attaching to avoid duplicate entries in the database."
},
{
"tag": "fixed",
"description": "Correct Benchmark job directory access when there is a trailing slash in the specified benchmark data directory."
},
{
"tag": "fixed",
"description": "Restrict accidental cloning of certain Live-managed jobs."
},
{
"tag": "fixed",
"description": "Fixed an issue where event log PDF downloads for certain jobs (eg. Manually Curate Exposures) would fail due to control characters being interpreted incorrectly."
},
{
"tag": "fixed",
"description": "Fixed an issue where the interactive scatter plot for 3D Variability Display would not update its layout when the window resized."
},
{
"tag": "fixed",
"description": "Job PDF report now states the version of CryoSPARC the job was run with, not the version of CryoSPARC running when downloading the report."
},
{
"tag": "fixed",
"description": "Resolved an issue where job output image previews did not display on the ‘Outputs’ tab when previewing a job."
}
]
},
{
"tag": "v4.4.1+240110 (Patch)",
"date": "01/10/2024",
"items": [
{
"tag": "fixed",
"description": "<code>cryosparcm</code> commands <code>configuredb</code> and <code>patch</code> no longer show a segmentation fault after successful completion."
},
{
"tag": "fixed",
"description": "Log messages for project and job size updates no longer contain inconsistent counts."
},
{
"tag": "fixed",
"description": "Fixed issue introduced in v4.4.1 where benchmark job would not complete GPU Engine benchmarks."
},
{
"tag": "fixed",
"description": "Reference-based motion correction no longer fails if GPUs are configured in <code>EXCLUSIVE_PROCESS</code> mode."
}
]
},
{
"tag": "v4.4.1",
"date": "12/05/2023",
"items": [
{
"tag": "update",
"description" : "The volume viewer now supports many more types of volume outputs: <code>map</code>, <code>map_sharp</code>, <code>map_aligned</code>, <code>map_half_A</code>, <code>map_half_B</code>, <code>map_sym</code>, <code>map_sym_sharp</code>, <code>map_filtered</code>, <code>map_3DFSC</code>"
},
{
"tag": "update",
"description" : "Attempting to unarchive a project will now fail if the directory specified does not contain a the same project UID that is being unarchived. The target project directory’s <code>project.json</code> file is checked to see if it matches the UID of the project selected in the UI."
},
{
"tag": "update",
"description" : "Exposure Group Utilities now creates the <code>exposure</code> and <code>particle</code> output groups at build time rather than run time, enabling the job to be used in Workflows."
},
{
"tag": "update",
"description" : "Align 3D’s <code>volume</code> output group now outputs a <code>map</code> output, identical to the <code>map_aligned</code> output, for enabling drag-and-drop connection to refinement job input groups."
},
{
"tag": "update",
"description" : "The Benchmark job now includes a new <code>class3D-small</code> benchmark to test minimum supported hardware specs (32GB DRAM, 11GB VRAM). GPU benchmarks also now allow any specific benchmark to fail without halting the overall benchmark job."
},
{
"tag": "fixed",
"description" : "Fixed an issue where the default blueprint ‘2D Classification (Small Particle)’ would fail due to a missing custom parameter."
},
{
"tag": "fixed",
"description" : "Fixed an issue which caused the 3DVA Display job to sometimes duplicate upstream 3DVA component slots at build time."
},
{
"tag": "fixed",
"description" : "Fixed an issue causing Remove Duplicate Particles and 2D Classification to occasionally fail with an AssertionError."
},
{
"tag": "fixed",
"description" : "Fixed an issue where the ability to toggle display of denoised micrograph within Exposure Curation was not showing."
},
{
"tag": "fixed",
"description" : "Fixed an issue which caused I/O error messages to be displayed without the specific reason for the failure."
},
{
"tag": "fixed",
"description" : "Fixed an issue which could cause reference based motion correction to crash when a defect file was in use."
},
{
"tag": "fixed",
"description" : "Fixed an issue where reference based motion correction could crash with a message about the variable ‘uid’ being referenced before assignment."
},
{
"tag": "fixed",
"description" : "Increased memory limit per movie for reference based motion correction from 100 GB to the machine’s physical RAM."
},
{
"tag": "fixed",
"description" : "Fixed an issue where thumbnails were not being updated when manually rejecting exposures in the exposure curation cards view with a filter set."
},
{
"tag": "fixed",
"description" : "Project level parameter defaults are longer reset when creating a job from a blueprint (all parameters are still reset when applying a blueprint to an existing job)."
},
{
"tag": "fixed",
"description" : "Template picking in Live no longer fails when only one template is selected."
},
{
"tag": "fixed",
"description" : "External dependencies that were removed in older versions of CryoSPARC are no longer installed."
},
{
"tag": "fixed",
"description" : "Fixed an issue where all required directories were not being checked for existence when restoring from backup."
},
{
"tag": "fixed",
"description" : "<code>MONGO_EXTRA_FLAGS</code> is no longer included in the default configuration file after installation."
}
]
},
{
"tag": "v4.4.0+231114 (Patch)",
"date": "11/14/2023",
"items": [
{
"tag": "update",
"description": "Improved error message when driver version is incorrect"
},
{
"tag": "fixed",
"description": "CryoSPARC Live session worker jobs no longer fail during particle picking on sessions created prior to v4.4"
},
{
"tag": "fixed",
"description": "CryoSPARC Live sessions created prior to v4.4 no longer fail during pausing and exporting particles"
},
{
"tag": "fixed",
"description": "Class Probability Filter job no longer fails when particle blobs are not available"
},
{
"tag": "fixed",
"description": "Benchmark job correctly runs with more than one GPU"
},
{
"tag": "fixed",
"description": "Benchmark job no longer fails if benchmark data is outside the project directory"
},
{
"tag": "fixed",
"description": "Small Particle parameter definition in default blueprint is now correct"
}
]
},
{
"tag": "v4.4.0",
"date": "11/08/2023",
"items": [
{
"tag": "new",
"description": "<p><a href=\"https://guide.cryosparc.com/setup-configuration-and-management/cryosparc-installation-prerequisites#1.-cuda-toolkit\">CryoSPARC now bundles CUDA Toolkit 11.8</a>; a separate CUDA Toolkit installation no is longer required by the CryoSPARC worker application.<br /><strong>BREAKING</strong>: CryoSPARC v4.4 requires NVIDIA driver version 520.61.05 or newer.</p>"
},
{
"tag": "new",
"description": "<p><strong>Introducing <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/workflows\">Workflows</a> and <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/blueprints\">Blueprints</a>:</strong></p> <ul> <li>→ <strong><a href=\"https://guide.cryosparc.com/application-guide-v4.0+/workflows\">Workflows</a></strong>: Workflows make it easy to replicate processing that you’ve done before. Select a chain of jobs to create a templated processing Workflow, and re-create it in any project or workspace with a single click. Annotate the Workflow with a description and tags, set up default or locked parameter choices, and easily share Workflows from one CryoSPARC instance to another.</li> <li>→ Workflows are flexible. You can create a linear Workflow that for example, starts with an import job and proceeds all the way to a refinement, to make it easier to process a new dataset using an existing set of steps. Alternatively, you can select a portion of a processing workflow that you would like to re-use for exploratory processing (e.g., for sorting particles or separating heterogeneity).</li> <li>→ Use Workflows to save time, to maintain consistency and repeatability, and to capture important target-specific or facility-specific processing details and patterns so that new users can get a head start.</li> <li>→ <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/workflows\">Watch a tutorial video and read the in-depth Workflows guide to get started.</a></li> <li>→ <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/blueprints\">Blueprints</a></strong>: Blueprints allow you to define custom parameters and annotations as a template for any job type. Apply the Blueprint to an existing job or create a new job from a Blueprint directly from the job builder, in any workspace or project.</li> <li>→ Save time and avoid mistakes in entering parameter values by creating Blueprints for e.g., import jobs for specific microscope setups, classification and refinement jobs for specific protein types or sizes, settings for specific computational configurations, etc.</li> <li>→ Create Blueprints to avoid searching across projects for the parameters of previous runs of a particular job type. Easily export, share, and import Blueprints from one CryoSPARC instance to another.</li> <li>→ <a href=\"https://guide.cryosparc.com/application-guide-v4.0+/blueprints\">Read the in-depth Blueprints guide to get started.</a></li></ul>"
},
{
"tag": "new",
"description": "<p><strong><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta\">Reference Based Motion Correction (BETA)</a></strong> in CryoSPARC improves final resolution and map quality by re-estimating per-particle motion trajectories using a reference volume, similar to Bayesian Polishing (Zivanov et al, 2019).</p> <ul> <li>→ Before running Reference Based Motion Correction, you must run Patch Motion on your input movies and take the extracted particles through a 3D refinement.</li> <li>→ The reference density and particle poses from 3D refinement are used to go back to the input movies and re-extract particles with optimized motion trajectories. Reference Based Motion Correction is multi-GPU accelerated and optimized, and includes a <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta#hyperparameter-search\">new method for hyperparameter optimization</a>.</li> <li>→ The job also computes optimal empirical dose weights by comparing aligned particles against the reference density, and uses these to weight contribution from early and late frames of the input movies. This dose weighting is often <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta#sample-results\">responsible for a large part of the improvement from Reference Based Motion Correction</a>. In CryoSPARC v4.4, Patch Motion correction can now accept empirical dose weights as input, e.g. from previous processing of a similar dataset, so that empirical dose weights can be applied right from the start of the processing pipeline.</li> <li>→ <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta#empiar-10261-nav1.7-ion-channel\">Reference Based Motion Correction can also perform motion estimation of particles from multiple heterogeneous classes simultaneously</a>, and uses particles from all classes in each micrograph to constrain motion trajectories, potentially leading to improved results over processing each class separately.</li> <li>→ <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta#tutorial-video\">Watch a detailed tutorial video</a> to learn how to use the job, and <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/motion-correction/job-reference-based-motion-correction-beta\">read the job documentation for theory and more details about the method</a>.</li></ul>"
},
{
"tag": "new",
"description": "<p><strong><a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-orientation-diagnostics\">Orientation Diagnostics</a>,</strong> a job that rapidly computes a set of easily interpretable diagnostics to identify orientation bias and anisotropic signal content in 3D refinement results. Quickly identify potential data collection, sample preparation, or particle picking/curation issues with two complementary statistics: <strong>Conical FSC Area Ratio (cFAR)</strong>, sensitive to anisotropy in signal content and alignments and <strong>Sampling Compensation Factor</strong> <strong>(SCF*)</strong>, sensitive to anisotropy in alignments (Baldwin and Lyumkis, 2020).</p> <ul> <li>→ <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-orientation-diagnostics\">Several new diagnostic plots</a> allow for in-depth analysis of directional variation in FSCs and particle scale factors. The generated diagnostics include the values and plots previously produced by the 3DFSC wrapper job, which is now a legacy job.</li> <li>→ <a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-orientation-diagnostics\">Read a tutorial</a> on how to use the job, and read the <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/utilities/job-orientation-diagnostics\">job documentation for theory and more details about the method</a>.</li></ul>"
},
{
"tag": "new",
"description": "<strong><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/3d-refinement/job-non-uniform-refinement-new\">Non-Uniform Refinement</a> is up to 2x faster:</strong> the core computation for non-uniform cross-validation regularization is optimized on GPU to be 7x-10x faster. This translates to approximately 2x faster overall run time for Non-Uniform refinement jobs, and Helical and Local Refinement jobs with non-uniform regularization enabled."
},
{
"tag": "new",
"description": "<p><strong><a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-3d-flexible-refinement#job-types\">3D Flex Reconstruction</a></strong> job now supports CTF aberrations during high-resolution reconstruction. Also, there is now an option to read particles from SSD cache or from project directories during reconstruction, rather than loading all particles into RAM. This option substantially decreases the CPU RAM requirements for reconstruction.</p><ul><li>→ In addition, 3D Flex dependencies are now bundled with CryoSPARC and no longer require a separate online installation step. 3D Flex now supports the latest NVIDIA GPU compute capabilities 8.9 and 9.0.</li></ul>"
},
{
"tag": "new",
"description": "<p><strong><a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-symmetry-relaxation\">Symmetry Relaxation:</a></strong> There is now an option to relax the pose search over symmetry-related views in Homogeneous and Non-Uniform Refinement.</p><ul><li>→ A “break symmetry” option is available in Homogeneous Reconstruction that randomizes particle poses over the chosen symmetry group.</li></ul>"
},
{
"tag": "new",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-float16-support\"><code>float16</code> Support:</a> Particles and motion-corrected micrographs can now be output in 16-bit floating point format, via a new parameter in motion correction and extraction jobs. This can cut disk usage in half for large projects. The option to output <code>float16</code> can also be set as a project-level default parameter."
},
{
"tag": "new",
"description": "<p><strong><a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-epu-afis-beam-shift-import\">AFIS Beam Shift Import:</a></strong> In Import Movies and Import Micrographs, beam shift values for data collected in EPU via the Aberration-Free Image Shift (AFIS) method can now be directly imported, and exposure groups created based on clusters of beam shift values.</p> <ul> <li>→ For existing exposure datasets in CryoSPARC, add beam shift information using the new <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/import/job-import-beam-shift\">Import Beam Shift</a> job. In the Exposure Group Utilities job, cluster exposures into exposure groups based on imported beam shift values automatically.</li></ul>"
},
{
"tag": "new",
"description": "<strong><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-regroup-3d\">Regroup 3D</a></strong> job quickly creates a set of ‘superclasses’ from a larger set of upstream 3D Classification or Heterogeneous Refinement classes. It uses a lightweight spectral clustering algorithm that can aid in identifying dominant conformational variations."
},
{
"tag": "new",
"description": "<strong><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/3d-refinement/job-heterogeneous-reconstruction-only\">Heterogeneous Reconstruction Only</a></strong> job reconstructs multiple classes from upstream 3D Classification, Heterogeneous Refinement, or Regroup 3D outputs. It uses weighted back-projection via upstream class posteriors, with an option to apply hard classification. It includes similar reconstruction options as the Homogeneous Reconstruct Only job (including symmetry, box size, etc.)."
},
{
"tag": "new",
"description": "Viewing direction distribution plots now include an option to <a href=\"https://guide.cryosparc.com/processing-data/tutorials-and-case-studies/tutorial-bild-files-in-cryosparc-v4.4+\">export as a BILD file for visualization in UCSF Chimera(X)</a>."
},
{
"tag": "new",
"description": "Experimental SSD cache system with significantly improved reliability and support for network drives. To enable, add <code>export CRYOSPARC_IMPROVED_SSD_CACHE=true</code> to <code>cryosparc_worker/config.sh</code>. <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring/environment-variables#cryosparc_worker-config.sh\">See the guide for more details.</a>"
},
{
"tag": "new",
"description": "<p>Improved behaviour of the <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-data-cleanup-v4.3+\"><strong>Data Cleanup Tool</strong></a> to streamline compaction of projects and workspaces:</p> <ul> <li>→ All options are unchecked by default.</li> <li>→ When running the Cleanup Data tool on a single workspace within a project, jobs that are linked to other workspaces will no longer be deleted by the tool; instead those jobs will be unlinked from the workspace being cleaned and will remain present in the other workspaces.</li> <li>→ CryoSPARC Live jobs, which are excluded from the cleanup process, are marked as “Skipped” and their size is now displayed.</li> <li>→ The total project directory size is now displayed in the cleanup tool along with the total size of data that the tool can clear, which may be different due to imported and manually copied files that may be present in the project directory.</li></ul>"
},
{
"tag": "new",
"description": "<strong><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/particle-curation/job-2d-classification\">2D Classification</a></strong> implementation that reduces memory usage and provides speedups with larger datasets. The original implementation is available as a legacy job type."
},
{
"tag": "new",
"description": "<strong><a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/particle-curation/job-reconstruct-2d-classes\">Reconstruct 2D Classes</a></strong> job that reconstructs 2D class averages from previously classified particles."
},
{
"tag": "new",
"description": "Ability to set custom parameters within the Live session view when configuring custom Streaming 2D Classification, Ab-inito and Streaming Refinement jobs."
},
{
"tag": "new",
"description": "Job cards now indicate warnings and errors, along with a text preview. If a job contains warnings or encountered an error, an icon will display in the cards and tree view. Hovering over the icon will display more information about the warning/error. A subset of the error will be visible directly on the job card view if applicable."
},
{
"tag": "new",
"description": "Ability to copy parameter code name via the ‘Inputs and Parameters’ tab when previewing a job. This name can be used in <a href=\"https://tools.cryosparc.com/intro.html\"><code>cryosparc-tools</code> scripts</a>."
},
{
"tag": "new",
"description": "If a job exists in more than one workspace, an icon and informational tooltip will be show on the cards view. In addition, jobs that display in the tree view but are not explicitly linked to the selected workspace are marked with an icon and informational tooltip for additional context."
},
{
"tag": "new",
"description": "Ability to star a Live session from within the session view through the primary dropdown menu."
},
{
"tag": "new",
"description": "Import Particles contains a new set of parameters to enable build-time output group generation and validation. This allows Import Particles to be used within Workflows for automated processing."
},
{
"tag": "new",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/simulations/job-simulate-data-gpu\">Simulate Data job</a> that is now GPU accelerated. The previous implementation is available as a legacy job."
},
{
"tag": "update",
"description": "The <a href=\"https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-performance-benchmarking-v4.3+\">Performance Benchmarks</a> system now captures benchmarks from the core algorithms used in 2D Classification and 3D Classification jobs. In addition, reference GPU Benchmarks have been added for the <code>RTX 4090</code>, <code>A100 PCIE-40GB</code>, <code>RTX 3090</code>, and <code>A4000</code> GPUs, as well as for <code>AWS EC2 g5</code> instances with FSx for Lustre and local NVME SSDs."
},
{
"tag": "update",
"description": "The <a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/post-processing/job-validation-fsc\">Validation (FSC) job</a> now outputs an additional FSC figure with square plot markers along with a line, to more clearly see each resolution shell."
},
{
"tag": "update",
"description": "<a href=\"https://guide.cryosparc.com/processing-data/all-job-types-in-cryosparc/variability/job-3d-variability-display\">3D Variability Display</a> now includes an option to create intermediate reconstructions with equal numbers of particles in each frame. The job now also allows up to 100 input components instead of 20."
},
{
"tag": "update",
"description": "2D Classification now has an option to set a minimum alignment resolution that provides the ability to high-pass filter references during classification and can be useful for smaller particles in some cases. The job also has an option to display a scale bar on the 2D class averages figure."
},
{
"tag": "update",
"description": "Heterogeneous Refinement now correctly accounts for the <code>Backprojection resolution factor</code> parameter; the job card image display is improved when there are classes of very low resolution; the <code>Initial random assignment iterations</code> parameter now applies only if non-distinct initial volumes are provided; and the job now outputs a volume series containing all the classes that were produced."
},
{
"tag": "update",
"description": "3D Classification now filters the consensus volume according to its FSC and outputs the result for downstream use."
},
{
"tag": "update",
"description": "Sharpening Tools job now estimates a B-factor using a Guinier plot if a sharpening B-factor is not provided, with options to include mask and FSC weights prior to estimation."
},
{
"tag": "update",
"description": "Downsample Particles now allows ‘uncropping’: when the desired box size is larger than the input particle box size, the particles are padded in real space and the padded region is filled with the mean value of the particle."
},
{
"tag": "update",
"description": "Downsample particles now has an option to re-center particles according to their shifts."
},
{
"tag": "update",
"description": "The Rebalance 2D Classes job now displays a plot of the pairwise affinity matrix between 2D classes, and also updates particle’s 2D alignments to be in-register within each superclass. Also, the job now always outputs combined datasets for particles and templates, even if “Split outputs” was activated."
},
{
"tag": "update",
"description": "The legacy web application (deprecated since CryoSPARC v3.0 in December 2021) that could be spawned via <code>cryosparcm start app_legacy</code> and operated at <code>BASE_PORT + 7</code> is no longer bundled with CryoSPARC."
},
{
"tag": "update",
"description": "The CryoSPARC database now has <a href=\"https://www.mongodb.com/docs/manual/core/journaling/\">journaling</a> turned on by default, increasing durability in the event of a failure."
},
{
"tag": "update",
"description": "When a job is in building status, any custom parameters set are visible on the job card in the tree view."
},
{
"tag": "update",
"description": "CryoSPARC Live sessions now use 10% less storage space per micrograph in the database by reducing the number of plots created during preprocessing. To turn on all plotting, enable the “Enable Plotting in RTP Worker” session parameter."
},
{
"tag": "update",
"description": "CryoSPARC Live Session UIDs now increment monotonically, independent from Workspace UID."
},
{
"tag": "update",
"description": "Micrograph images with pick locations overlayed can now be downloaded from the micrograph viewer in CryoSPARC Live."
},
{
"tag": "update",
"description": "The job details sidebar now shows the last time a job was exported and the path to which it was exported, to make it easy to find exported data."
},
{
"tag": "update",
"description": "The recent jobs sidebar can now be toggled to show either the user’s jobs only or all instance jobs, as well as showing completed, failed, and killed jobs."
},
{
"tag": "update",
"description": "In Blob Picker and Filament Tracer, the templates are now available as outputs, along with the particles."
},
{
"tag": "update",
"description": "The Template Picker now has a parameter to disable automatic re-centering of the template image, which has been known to cause issues in some cases."
},
{
"tag": "update",
"description": "Exposure Sets Tools and Particle Sets Tools now generate their output groups before they are run, allowing these jobs to be part of pre-defined Workflows."
},
{
"tag": "update",
"description": "Volume Tools now can invert masks without applying a threshold."
},
{
"tag": "update",
"description": "Volume Tools now specifies that the units for the dilation radius and the padding width are in pixels, and the default soft mask padding is set to 12 pixels."
},