@@ -55,7 +55,8 @@ def forcefield_job(method: Callable) -> job:
55
55
settings for all forcefield jobs. For example, it ensures that large data objects
56
56
(currently only trajectories) are all stored in the atomate2 data store.
57
57
It also configures the output schema to be a
58
- ForceFieldStructureTaskDocument :obj:`.TaskDoc`.
58
+ ForceFieldStructureTaskDocument :obj:`.TaskDoc`. or
59
+ ForceFieldMoleculeTaskDocument :obj:`.TaskDoc`.
59
60
60
61
Any makers that return forcefield jobs (not flows) should decorate the
61
62
``make`` method with @forcefield_job. For example:
@@ -123,7 +124,8 @@ class ForceFieldRelaxMaker(AseRelaxMaker):
123
124
tags : list[str] or None
124
125
A list of tags for the task.
125
126
task_document_kwargs : dict (deprecated)
126
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
127
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
128
+ :obj: `ForceFieldMoleculeTaskDocument`.
127
129
"""
128
130
129
131
name : str = "Force field relax"
@@ -217,7 +219,8 @@ class ForceFieldStaticMaker(ForceFieldRelaxMaker):
217
219
calculator_kwargs : dict
218
220
Keyword arguments that will get passed to the ASE calculator.
219
221
task_document_kwargs : dict (deprecated)
220
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
222
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
223
+ :obj: `ForceFieldMoleculeTaskDocument`.
221
224
"""
222
225
223
226
name : str = "Force field static"
@@ -260,7 +263,8 @@ class CHGNetRelaxMaker(ForceFieldRelaxMaker):
260
263
calculator_kwargs : dict
261
264
Keyword arguments that will get passed to the ASE calculator.
262
265
task_document_kwargs : dict (deprecated)
263
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
266
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
267
+ :obj: `ForceFieldMoleculeTaskDocument`.
264
268
"""
265
269
266
270
name : str = f"{ MLFF .CHGNet } relax"
@@ -296,7 +300,8 @@ class CHGNetStaticMaker(ForceFieldStaticMaker):
296
300
calculator_kwargs : dict
297
301
Keyword arguments that will get passed to the ASE calculator.
298
302
task_document_kwargs : dict (deprecated)
299
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
303
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
304
+ :obj: `ForceFieldMoleculeTaskDocument`.
300
305
"""
301
306
302
307
name : str = f"{ MLFF .CHGNet } static"
@@ -339,7 +344,8 @@ class M3GNetRelaxMaker(ForceFieldRelaxMaker):
339
344
calculator_kwargs : dict
340
345
Keyword arguments that will get passed to the ASE calculator.
341
346
task_document_kwargs : dict (deprecated)
342
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
347
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
348
+ :obj: `ForceFieldMoleculeTaskDocument`.
343
349
"""
344
350
345
351
name : str = f"{ MLFF .M3GNet } relax"
@@ -377,7 +383,8 @@ class M3GNetStaticMaker(ForceFieldStaticMaker):
377
383
calculator_kwargs : dict
378
384
Keyword arguments that will get passed to the ASE calculator.
379
385
task_document_kwargs : dict (deprecated)
380
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
386
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
387
+ :obj: `ForceFieldMoleculeTaskDocument`.
381
388
"""
382
389
383
390
name : str = f"{ MLFF .M3GNet } static"
@@ -420,7 +427,8 @@ class NEPRelaxMaker(ForceFieldRelaxMaker):
420
427
calculator_kwargs : dict
421
428
Keyword arguments that will get passed to the ASE calculator.
422
429
task_document_kwargs : dict (deprecated)
423
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
430
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
431
+ :obj: `ForceFieldMoleculeTaskDocument`.
424
432
"""
425
433
426
434
name : str = f"{ MLFF .NEP } relax"
@@ -456,7 +464,8 @@ class NEPStaticMaker(ForceFieldStaticMaker):
456
464
calculator_kwargs : dict
457
465
Keyword arguments that will get passed to the ASE calculator.
458
466
task_document_kwargs : dict (deprecated)
459
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
467
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
468
+ :obj: `ForceFieldMoleculeTaskDocument`.
460
469
"""
461
470
462
471
name : str = f"{ MLFF .NEP } static"
@@ -499,7 +508,8 @@ class NequipRelaxMaker(ForceFieldRelaxMaker):
499
508
calculator_kwargs : dict
500
509
Keyword arguments that will get passed to the ASE calculator.
501
510
task_document_kwargs : dict (deprecated)
502
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
511
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
512
+ :obj: `ForceFieldMoleculeTaskDocument`.
503
513
"""
504
514
505
515
name : str = f"{ MLFF .Nequip } relax"
@@ -534,7 +544,8 @@ class NequipStaticMaker(ForceFieldStaticMaker):
534
544
calculator_kwargs : dict
535
545
Keyword arguments that will get passed to the ASE calculator.
536
546
task_document_kwargs : dict (deprecated)
537
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
547
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
548
+ :obj: `ForceFieldMoleculeTaskDocument`.
538
549
"""
539
550
540
551
name : str = f"{ MLFF .Nequip } static"
@@ -581,7 +592,8 @@ class MACERelaxMaker(ForceFieldRelaxMaker):
581
592
trained for Matbench Discovery on the MPtrj dataset available at
582
593
https://figshare.com/articles/dataset/22715158.
583
594
task_document_kwargs : dict (deprecated)
584
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
595
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
596
+ :obj: `ForceFieldMoleculeTaskDocument`.
585
597
"""
586
598
587
599
name : str = f"{ MLFF .MACE_MP_0 } relax"
@@ -621,7 +633,8 @@ class MACEStaticMaker(ForceFieldStaticMaker):
621
633
trained for Matbench Discovery on the MPtrj dataset available at
622
634
https://figshare.com/articles/dataset/22715158.
623
635
task_document_kwargs : dict (deprecated)
624
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
636
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
637
+ :obj: `ForceFieldMoleculeTaskDocument`.
625
638
"""
626
639
627
640
name : str = f"{ MLFF .MACE_MP_0 } static"
@@ -670,7 +683,8 @@ class SevenNetRelaxMaker(ForceFieldRelaxMaker):
670
683
trained for Matbench Discovery on the MPtrj dataset available at
671
684
https://figshare.com/articles/dataset/22715158.
672
685
task_document_kwargs : dict (deprecated)
673
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
686
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
687
+ :obj: `ForceFieldMoleculeTaskDocument`.
674
688
"""
675
689
676
690
name : str = f"{ MLFF .SevenNet } relax"
@@ -712,7 +726,8 @@ class SevenNetStaticMaker(ForceFieldStaticMaker):
712
726
trained for Matbench Discovery on the MPtrj dataset available at
713
727
https://figshare.com/articles/dataset/22715158.
714
728
task_document_kwargs : dict (deprecated)
715
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
729
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
730
+ :obj: `ForceFieldMoleculeTaskDocument`.
716
731
"""
717
732
718
733
name : str = f"{ MLFF .SevenNet } static"
@@ -752,7 +767,8 @@ class GAPRelaxMaker(ForceFieldRelaxMaker):
752
767
calculator_kwargs : dict
753
768
Keyword arguments that will get passed to the ASE calculator.
754
769
task_document_kwargs : dict (deprecated)
755
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
770
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
771
+ :obj: `ForceFieldMoleculeTaskDocument`.
756
772
"""
757
773
758
774
name : str = f"{ MLFF .GAP } relax"
@@ -788,7 +804,8 @@ class GAPStaticMaker(ForceFieldStaticMaker):
788
804
calculator_kwargs : dict
789
805
Keyword arguments that will get passed to the ASE calculator.
790
806
task_document_kwargs : dict (deprecated)
791
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
807
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
808
+ :obj: `ForceFieldMoleculeTaskDocument`.
792
809
"""
793
810
794
811
name : str = f"{ MLFF .GAP } static"
0 commit comments