@@ -53,7 +53,8 @@ def forcefield_job(method: Callable) -> job:
53
53
settings for all forcefield jobs. For example, it ensures that large data objects
54
54
(currently only trajectories) are all stored in the atomate2 data store.
55
55
It also configures the output schema to be a
56
- ForceFieldStructureTaskDocument :obj:`.TaskDoc`.
56
+ ForceFieldStructureTaskDocument :obj:`.TaskDoc`. or
57
+ ForceFieldMoleculeTaskDocument :obj:`.TaskDoc`.
57
58
58
59
Any makers that return forcefield jobs (not flows) should decorate the
59
60
``make`` method with @forcefield_job. For example:
@@ -121,7 +122,8 @@ class ForceFieldRelaxMaker(AseRelaxMaker):
121
122
tags : list[str] or None
122
123
A list of tags for the task.
123
124
task_document_kwargs : dict (deprecated)
124
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
125
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
126
+ :obj: `ForceFieldMoleculeTaskDocument`.
125
127
"""
126
128
127
129
name : str = "Force field relax"
@@ -215,7 +217,8 @@ class ForceFieldStaticMaker(ForceFieldRelaxMaker):
215
217
calculator_kwargs : dict
216
218
Keyword arguments that will get passed to the ASE calculator.
217
219
task_document_kwargs : dict (deprecated)
218
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
220
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
221
+ :obj: `ForceFieldMoleculeTaskDocument`.
219
222
"""
220
223
221
224
name : str = "Force field static"
@@ -258,7 +261,8 @@ class CHGNetRelaxMaker(ForceFieldRelaxMaker):
258
261
calculator_kwargs : dict
259
262
Keyword arguments that will get passed to the ASE calculator.
260
263
task_document_kwargs : dict (deprecated)
261
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
264
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
265
+ :obj: `ForceFieldMoleculeTaskDocument`.
262
266
"""
263
267
264
268
name : str = f"{ MLFF .CHGNet } relax"
@@ -294,7 +298,8 @@ class CHGNetStaticMaker(ForceFieldStaticMaker):
294
298
calculator_kwargs : dict
295
299
Keyword arguments that will get passed to the ASE calculator.
296
300
task_document_kwargs : dict (deprecated)
297
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
301
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
302
+ :obj: `ForceFieldMoleculeTaskDocument`.
298
303
"""
299
304
300
305
name : str = f"{ MLFF .CHGNet } static"
@@ -337,7 +342,8 @@ class M3GNetRelaxMaker(ForceFieldRelaxMaker):
337
342
calculator_kwargs : dict
338
343
Keyword arguments that will get passed to the ASE calculator.
339
344
task_document_kwargs : dict (deprecated)
340
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
345
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
346
+ :obj: `ForceFieldMoleculeTaskDocument`.
341
347
"""
342
348
343
349
name : str = f"{ MLFF .M3GNet } relax"
@@ -375,7 +381,8 @@ class M3GNetStaticMaker(ForceFieldStaticMaker):
375
381
calculator_kwargs : dict
376
382
Keyword arguments that will get passed to the ASE calculator.
377
383
task_document_kwargs : dict (deprecated)
378
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
384
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
385
+ :obj: `ForceFieldMoleculeTaskDocument`.
379
386
"""
380
387
381
388
name : str = f"{ MLFF .M3GNet } static"
@@ -418,7 +425,8 @@ class NEPRelaxMaker(ForceFieldRelaxMaker):
418
425
calculator_kwargs : dict
419
426
Keyword arguments that will get passed to the ASE calculator.
420
427
task_document_kwargs : dict (deprecated)
421
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
428
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
429
+ :obj: `ForceFieldMoleculeTaskDocument`.
422
430
"""
423
431
424
432
name : str = f"{ MLFF .NEP } relax"
@@ -454,7 +462,8 @@ class NEPStaticMaker(ForceFieldStaticMaker):
454
462
calculator_kwargs : dict
455
463
Keyword arguments that will get passed to the ASE calculator.
456
464
task_document_kwargs : dict (deprecated)
457
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
465
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
466
+ :obj: `ForceFieldMoleculeTaskDocument`.
458
467
"""
459
468
460
469
name : str = f"{ MLFF .NEP } static"
@@ -497,7 +506,8 @@ class NequipRelaxMaker(ForceFieldRelaxMaker):
497
506
calculator_kwargs : dict
498
507
Keyword arguments that will get passed to the ASE calculator.
499
508
task_document_kwargs : dict (deprecated)
500
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
509
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
510
+ :obj: `ForceFieldMoleculeTaskDocument`.
501
511
"""
502
512
503
513
name : str = f"{ MLFF .Nequip } relax"
@@ -532,7 +542,8 @@ class NequipStaticMaker(ForceFieldStaticMaker):
532
542
calculator_kwargs : dict
533
543
Keyword arguments that will get passed to the ASE calculator.
534
544
task_document_kwargs : dict (deprecated)
535
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
545
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
546
+ :obj: `ForceFieldMoleculeTaskDocument`.
536
547
"""
537
548
538
549
name : str = f"{ MLFF .Nequip } static"
@@ -579,7 +590,8 @@ class MACERelaxMaker(ForceFieldRelaxMaker):
579
590
trained for Matbench Discovery on the MPtrj dataset available at
580
591
https://figshare.com/articles/dataset/22715158.
581
592
task_document_kwargs : dict (deprecated)
582
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
593
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
594
+ :obj: `ForceFieldMoleculeTaskDocument`.
583
595
"""
584
596
585
597
name : str = f"{ MLFF .MACE_MP_0 } relax"
@@ -619,7 +631,8 @@ class MACEStaticMaker(ForceFieldStaticMaker):
619
631
trained for Matbench Discovery on the MPtrj dataset available at
620
632
https://figshare.com/articles/dataset/22715158.
621
633
task_document_kwargs : dict (deprecated)
622
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
634
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
635
+ :obj: `ForceFieldMoleculeTaskDocument`.
623
636
"""
624
637
625
638
name : str = f"{ MLFF .MACE_MP_0 } static"
@@ -668,7 +681,8 @@ class SevenNetRelaxMaker(ForceFieldRelaxMaker):
668
681
trained for Matbench Discovery on the MPtrj dataset available at
669
682
https://figshare.com/articles/dataset/22715158.
670
683
task_document_kwargs : dict (deprecated)
671
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
684
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
685
+ :obj: `ForceFieldMoleculeTaskDocument`.
672
686
"""
673
687
674
688
name : str = f"{ MLFF .SevenNet } relax"
@@ -710,7 +724,8 @@ class SevenNetStaticMaker(ForceFieldStaticMaker):
710
724
trained for Matbench Discovery on the MPtrj dataset available at
711
725
https://figshare.com/articles/dataset/22715158.
712
726
task_document_kwargs : dict (deprecated)
713
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
727
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
728
+ :obj: `ForceFieldMoleculeTaskDocument`.
714
729
"""
715
730
716
731
name : str = f"{ MLFF .SevenNet } static"
@@ -750,7 +765,8 @@ class GAPRelaxMaker(ForceFieldRelaxMaker):
750
765
calculator_kwargs : dict
751
766
Keyword arguments that will get passed to the ASE calculator.
752
767
task_document_kwargs : dict (deprecated)
753
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
768
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
769
+ :obj: `ForceFieldMoleculeTaskDocument`.
754
770
"""
755
771
756
772
name : str = f"{ MLFF .GAP } relax"
@@ -786,7 +802,8 @@ class GAPStaticMaker(ForceFieldStaticMaker):
786
802
calculator_kwargs : dict
787
803
Keyword arguments that will get passed to the ASE calculator.
788
804
task_document_kwargs : dict (deprecated)
789
- Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`.
805
+ Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()` or
806
+ :obj: `ForceFieldMoleculeTaskDocument`.
790
807
"""
791
808
792
809
name : str = f"{ MLFF .GAP } static"
0 commit comments