diff --git a/atomate/__init__.py b/atomate/__init__.py index acec196db..66c04154f 100644 --- a/atomate/__init__.py +++ b/atomate/__init__.py @@ -1 +1 @@ -__version__ = "0.9.4" \ No newline at end of file +__version__ = "0.9.5" \ No newline at end of file diff --git a/docs/_sources/atomate.vasp.firetasks.rst.txt b/docs/_sources/atomate.vasp.firetasks.rst.txt index f2e04229c..7c14ade13 100644 --- a/docs/_sources/atomate.vasp.firetasks.rst.txt +++ b/docs/_sources/atomate.vasp.firetasks.rst.txt @@ -11,6 +11,14 @@ Subpackages Submodules ---------- +atomate.vasp.firetasks.exchange module +-------------------------------------- + +.. automodule:: atomate.vasp.firetasks.exchange + :members: + :undoc-members: + :show-inheritance: + atomate.vasp.firetasks.glue\_tasks module ----------------------------------------- diff --git a/docs/_sources/atomate.vasp.firetasks.tests.rst.txt b/docs/_sources/atomate.vasp.firetasks.tests.rst.txt index a8d1755d0..3e725097c 100644 --- a/docs/_sources/atomate.vasp.firetasks.tests.rst.txt +++ b/docs/_sources/atomate.vasp.firetasks.tests.rst.txt @@ -12,6 +12,14 @@ atomate.vasp.firetasks.tests.test\_copy module :undoc-members: :show-inheritance: +atomate.vasp.firetasks.tests.test\_exchange module +-------------------------------------------------- + +.. automodule:: atomate.vasp.firetasks.tests.test_exchange + :members: + :undoc-members: + :show-inheritance: + atomate.vasp.firetasks.tests.test\_get\_interpolated\_poscar module ------------------------------------------------------------------- diff --git a/docs/_sources/atomate.vasp.fireworks.rst.txt b/docs/_sources/atomate.vasp.fireworks.rst.txt index 9490e08b0..f82e94ade 100644 --- a/docs/_sources/atomate.vasp.fireworks.rst.txt +++ b/docs/_sources/atomate.vasp.fireworks.rst.txt @@ -12,6 +12,14 @@ atomate.vasp.fireworks.core module :undoc-members: :show-inheritance: +atomate.vasp.fireworks.exchange module +-------------------------------------- + +.. automodule:: atomate.vasp.fireworks.exchange + :members: + :undoc-members: + :show-inheritance: + atomate.vasp.fireworks.nmr module --------------------------------- diff --git a/docs/_sources/atomate.vasp.workflows.base.rst.txt b/docs/_sources/atomate.vasp.workflows.base.rst.txt index 31b694d3d..2f91b0d1d 100644 --- a/docs/_sources/atomate.vasp.workflows.base.rst.txt +++ b/docs/_sources/atomate.vasp.workflows.base.rst.txt @@ -44,6 +44,14 @@ atomate.vasp.workflows.base.elastic module :undoc-members: :show-inheritance: +atomate.vasp.workflows.base.exchange module +------------------------------------------- + +.. automodule:: atomate.vasp.workflows.base.exchange + :members: + :undoc-members: + :show-inheritance: + atomate.vasp.workflows.base.ferroelectric module ------------------------------------------------ diff --git a/docs/_sources/atomate.vasp.workflows.tests.rst.txt b/docs/_sources/atomate.vasp.workflows.tests.rst.txt index 62ff4bc8a..364abd6be 100644 --- a/docs/_sources/atomate.vasp.workflows.tests.rst.txt +++ b/docs/_sources/atomate.vasp.workflows.tests.rst.txt @@ -28,6 +28,14 @@ atomate.vasp.workflows.tests.test\_elastic\_workflow module :undoc-members: :show-inheritance: +atomate.vasp.workflows.tests.test\_exchange\_workflow module +------------------------------------------------------------ + +.. automodule:: atomate.vasp.workflows.tests.test_exchange_workflow + :members: + :undoc-members: + :show-inheritance: + atomate.vasp.workflows.tests.test\_ferroelectric\_workflow module ----------------------------------------------------------------- diff --git a/docs/_sources/changelog.rst.txt b/docs/_sources/changelog.rst.txt index 929794fbe..57c42db36 100644 --- a/docs/_sources/changelog.rst.txt +++ b/docs/_sources/changelog.rst.txt @@ -2,6 +2,14 @@ atomate Changelog ================= +**v0.9.5** + +* Add magnetism workflow (M. Horton, N. Frey) +* Overhaul SCAN workflow (R. Kingsbury) +* Move help to Discourse (A. Ganose) +* add ModifyKPoints Firetask (M. Siron) +* Misc fixes, dependency updates, and improvements (M. Horton, N. Frey, A. Jain, M. Siron, A. Ganose) + **v0.9.4** * Fixes for new pymatgen (S. Blau, S.P. Ong) diff --git a/docs/_sources/contributors.rst.txt b/docs/_sources/contributors.rst.txt index e6ada5387..4a280704d 100644 --- a/docs/_sources/contributors.rst.txt +++ b/docs/_sources/contributors.rst.txt @@ -7,9 +7,9 @@ atomate development is led by the Hacking Materials research group led by Anubha Contributions are provided by: * Alireza Faghaninia, Alex Dunn, Alex Ganose, and Evan Spotte-Smith through the research group of A. Jain at LBNL. -* Kiran Mathew, Shyam Dwaraknath, Joey Montoya, Murat Aykol, Patrick Huck, Brandon Wood, Sam Blau, Jimmy Shen, Anne Rutt, Eric Sivonxay, and Martin Siron through the research group of Prof. Kristin Persson at UC Berkeley. +* Kiran Mathew, Shyam Dwaraknath, Joey Montoya, Murat Aykol, Matt Horton, Patrick Huck, Brandon Wood, Sam Blau, Jimmy Shen, Ryan Kingsbury, Anne Rutt, Eric Sivonxay, and Martin Siron through the research group of Prof. Kristin Persson at UC Berkeley. * Hanmei Tang, Prof. Shyue Ping Ong, and the Materials Virtual Lab research group at UC San Diego. * Brandon Bocklund, who led the atomate documentation effort, through the research group of Prof. Zi-Kiu Liu at Penn State. * Tess Smidt through the research group of Prof. Jeff Neaton at UC Berkeley. * Danny Broberg through the research group of Prof. Mark Asta at UC Berkeley. -* External contributors: specter119, M. Dias Costa, S. Torrisi, Max Dylla, Marnik Bercx, Tara Maria Boland +* External contributors: specter119, M. Dias Costa, S. Torrisi, Max Dylla, Marnik Bercx, Tara Maria Boland, Nathan Frey, Martin Siron diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index ffea9688b..126511455 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.9.4', + VERSION: '0.9.5', LANGUAGE: 'None', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', diff --git a/docs/atomate.common.firetasks.html b/docs/atomate.common.firetasks.html index 05e8e3936..01ff8afd3 100644 --- a/docs/atomate.common.firetasks.html +++ b/docs/atomate.common.firetasks.html @@ -4,7 +4,7 @@
-Task to copy the given list of files from the given directory to the destination directory. To customize override the setup_copy and copy_files methods.
-from_dir (str): path to the directory containing the files to be copied. -to_dir (str): path to the destination directory +
from_dir (str): path to the directory containing the files to be copied. Supports env_chk. +to_dir (str): path to the destination directory. Supports env_chk. filesystem (str) -files_to_copy (list): list of file names. -exclude_files (list): list of file names to be excluded.
+files_to_copy (list): list of file names. Defaults to copying everything in from_dir. +exclude_files (list): list of file names to be excluded. +suffix (str): suffix to append to each filename when copying +++(e.g., rename ‘INCAR’ to ‘INCAR.precondition’)
+
in filenames is missing. Defaults to False.
+optional_params
= ['from_dir', 'to_dir', 'filesystem', 'files_to_copy', 'exclude_files']¶optional_params
= ['from_dir', 'to_dir', 'filesystem', 'files_to_copy', 'exclude_files', 'suffix', 'continue_on_missing']¶
setup_copy
(from_dir, to_dir=None, filesystem=None, files_to_copy=None, exclude_files=None, from_path_dict=None)¶setup_copy
(from_dir, to_dir=None, filesystem=None, files_to_copy=None, exclude_files=None, from_path_dict=None, suffix=None, fw_spec=None, continue_on_missing=False)¶
setup the copy i.e setup the from directory, filesystem, destination directory etc.
from_dir (str) to_dir (str) filesystem (str) files_to_copy (list): if None all the files in the from_dir will be copied -exclude_files (list) -from_path_dict (dict): dict specification of the path. If specified must contain atleast
+exclude_files (list): list of file names to be excluded. +suffix (str): suffix to append to each filename when copying-diff --git a/docs/atomate.common.firetasks.tests.html b/docs/atomate.common.firetasks.tests.html index df54f8cc4..dfa7a6937 100644 --- a/docs/atomate.common.firetasks.tests.html +++ b/docs/atomate.common.firetasks.tests.html @@ -4,7 +4,7 @@ -the key “path” that specifies the path to the from_dir.
++(e.g., rename ‘INCAR’ to ‘INCAR.precondition’)
+
@@ -131,7 +145,7 @@- continue_on_missing(bool): Whether to continue copying when a file
- +
in filenames is missing. Defaults to False.
+- from_path_dict (dict): dict specification of the path. If specified must contain atleast
- +
the key “path” that specifies the path to the from_dir.
+Submodules class
atomate.common.firetasks.glue_tasks.
CopyFilesFromCalcLoc
(*args, **kwargs)¶Bases:
-fireworks.core.firework.FiretaskBase
Based on CopyVaspOutputs but for general file copying. Note that “calc_locs” +
Based on CopyVaspOutputs but for general file copying. Note “calc_locs” must be set in the fw_spec. Files are copied to the current folder.
- Required params:
calc_loc: name of target fw to get location for within the calc_locs.
@@ -141,17 +155,23 @@Submodules
- -
+optional_params
= ['filenames', 'name_prepend', 'name_append']¶optional_params
= ['filenames', 'name_prepend', 'name_append', 'exclude_files']¶@@ -281,6 +301,48 @@
+Submodules +
- +class
+atomate.common.firetasks.glue_tasks.
GzipDir
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Task to gzip the current directory.
++
+ +- +
+optional_params
= []¶+
+ +- +
+required_params
= []¶+
+ +- +
+run_task
(fw_spec=None)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
+
- class
@@ -658,7 +720,7 @@atomate.common.firetasks.glue_tasks.
PassCalcLocs
(*args, **kwargs)¶Navigation
- modules |
- +atomate.common.firetasks.tests package — atomate 0.9.4 documentation +atomate.common.firetasks.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -207,7 +207,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.common.html b/docs/atomate.common.html index 1c1decfce..50eb57532 100644 --- a/docs/atomate.common.html +++ b/docs/atomate.common.html @@ -4,7 +4,7 @@ -atomate.common package — atomate 0.9.4 documentation +atomate.common package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -113,7 +113,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.firetasks.html b/docs/atomate.feff.firetasks.html index 1d0e283c9..2d78898e8 100644 --- a/docs/atomate.feff.firetasks.html +++ b/docs/atomate.feff.firetasks.html @@ -4,7 +4,7 @@ -atomate.feff.firetasks package — atomate 0.9.4 documentation +atomate.feff.firetasks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -444,7 +444,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.firetasks.tests.html b/docs/atomate.feff.firetasks.tests.html index 320cfb969..b7de3c8b7 100644 --- a/docs/atomate.feff.firetasks.tests.html +++ b/docs/atomate.feff.firetasks.tests.html @@ -4,7 +4,7 @@ -atomate.feff.firetasks.tests package — atomate 0.9.4 documentation +atomate.feff.firetasks.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -118,7 +118,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.fireworks.html b/docs/atomate.feff.fireworks.html index 13a848b50..a4078fe3b 100644 --- a/docs/atomate.feff.fireworks.html +++ b/docs/atomate.feff.fireworks.html @@ -4,7 +4,7 @@ -atomate.feff.fireworks package — atomate 0.9.4 documentation +atomate.feff.fireworks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -211,7 +211,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.fireworks.tests.html b/docs/atomate.feff.fireworks.tests.html index cbaaff802..c1da30d10 100644 --- a/docs/atomate.feff.fireworks.tests.html +++ b/docs/atomate.feff.fireworks.tests.html @@ -4,7 +4,7 @@ -atomate.feff.fireworks.tests package — atomate 0.9.4 documentation +atomate.feff.fireworks.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -113,7 +113,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.html b/docs/atomate.feff.html index 9cf735f53..df1687c76 100644 --- a/docs/atomate.feff.html +++ b/docs/atomate.feff.html @@ -4,7 +4,7 @@ -atomate.feff package — atomate 0.9.4 documentation +atomate.feff package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -183,7 +183,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.workflows.html b/docs/atomate.feff.workflows.html index 1a3d1af11..e24171fea 100644 --- a/docs/atomate.feff.workflows.html +++ b/docs/atomate.feff.workflows.html @@ -4,7 +4,7 @@ -atomate.feff.workflows package — atomate 0.9.4 documentation +atomate.feff.workflows package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -253,7 +253,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.feff.workflows.tests.html b/docs/atomate.feff.workflows.tests.html index d5e696858..e98355243 100644 --- a/docs/atomate.feff.workflows.tests.html +++ b/docs/atomate.feff.workflows.tests.html @@ -4,7 +4,7 @@ -atomate.feff.workflows.tests package — atomate 0.9.4 documentation +atomate.feff.workflows.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -186,7 +186,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.html b/docs/atomate.html index cff81fd0e..d0e7a8141 100644 --- a/docs/atomate.html +++ b/docs/atomate.html @@ -4,7 +4,7 @@ -atomate package — atomate 0.9.4 documentation +atomate package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -279,6 +279,7 @@Subpackagesatomate.vasp.firetasks.tests package
@@ -466,7 +466,7 @@
- Submodules
- atomate.vasp.firetasks.tests.test_copy module
+- atomate.vasp.firetasks.tests.test_exchange module
- atomate.vasp.firetasks.tests.test_get_interpolated_poscar module
- atomate.vasp.firetasks.tests.test_polarization_to_db module
- atomate.vasp.firetasks.tests.test_write_vasp module
@@ -289,6 +290,7 @@SubpackagesSubmodules +
- atomate.vasp.firetasks.exchange module
- atomate.vasp.firetasks.glue_tasks module
- atomate.vasp.firetasks.neb_tasks module
- atomate.vasp.firetasks.parse_outputs module
@@ -300,6 +302,7 @@Subpackagesatomate.vasp.fireworks package
diff --git a/docs/atomate.lammps.firetasks.html b/docs/atomate.lammps.firetasks.html index 7d4c15e6d..d4f6c7383 100644 --- a/docs/atomate.lammps.firetasks.html +++ b/docs/atomate.lammps.firetasks.html @@ -4,7 +4,7 @@ -
- Submodules
- atomate.vasp.fireworks.core module
+- atomate.vasp.fireworks.exchange module
- atomate.vasp.fireworks.nmr module
- atomate.vasp.fireworks.polarization module
- Module contents
@@ -322,6 +325,7 @@Subpackagesatomate.vasp.workflows.base.core module
- atomate.vasp.workflows.base.deformations module
- atomate.vasp.workflows.base.elastic module
+- atomate.vasp.workflows.base.exchange module
- atomate.vasp.workflows.base.ferroelectric module
- atomate.vasp.workflows.base.gibbs module
- atomate.vasp.workflows.base.magnetism module
@@ -343,6 +347,7 @@Subpackagesatomate.vasp.workflows.tests.test_adsorbate_workflow module
- atomate.vasp.workflows.tests.test_bulk_modulus_workflow module
- atomate.vasp.workflows.tests.test_elastic_workflow module
+- atomate.vasp.workflows.tests.test_exchange_workflow module
- atomate.vasp.workflows.tests.test_ferroelectric_workflow module
- atomate.vasp.workflows.tests.test_magnetism_workflow module
- atomate.vasp.workflows.tests.test_neb_workflow module
@@ -423,7 +428,7 @@Navigation
- modules |
- +atomate.lammps.firetasks package — atomate 0.9.4 documentation +atomate.lammps.firetasks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- +Navigation
- modules |
- + diff --git a/docs/atomate.lammps.fireworks.html b/docs/atomate.lammps.fireworks.html index b2b74eaee..3482ea4a6 100644 --- a/docs/atomate.lammps.fireworks.html +++ b/docs/atomate.lammps.fireworks.html @@ -4,7 +4,7 @@ -atomate.lammps.fireworks package — atomate 0.9.4 documentation +atomate.lammps.fireworks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -197,7 +197,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.lammps.html b/docs/atomate.lammps.html index b33d0c232..000cde090 100644 --- a/docs/atomate.lammps.html +++ b/docs/atomate.lammps.html @@ -4,7 +4,7 @@ -atomate.lammps package — atomate 0.9.4 documentation +atomate.lammps package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -266,7 +266,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.lammps.workflows.html b/docs/atomate.lammps.workflows.html index 37dc4b446..c77c98231 100644 --- a/docs/atomate.lammps.workflows.html +++ b/docs/atomate.lammps.workflows.html @@ -4,7 +4,7 @@ -atomate.lammps.workflows package — atomate 0.9.4 documentation +atomate.lammps.workflows package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -159,7 +159,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.firetasks.html b/docs/atomate.qchem.firetasks.html index 096fe867d..f509748c6 100644 --- a/docs/atomate.qchem.firetasks.html +++ b/docs/atomate.qchem.firetasks.html @@ -4,7 +4,7 @@ -atomate.qchem.firetasks package — atomate 0.9.4 documentation +atomate.qchem.firetasks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -767,7 +767,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.firetasks.tests.html b/docs/atomate.qchem.firetasks.tests.html index b31aaa81c..0b17caab2 100644 --- a/docs/atomate.qchem.firetasks.tests.html +++ b/docs/atomate.qchem.firetasks.tests.html @@ -4,7 +4,7 @@ -atomate.qchem.firetasks.tests package — atomate 0.9.4 documentation +atomate.qchem.firetasks.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -395,7 +395,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.fireworks.html b/docs/atomate.qchem.fireworks.html index 9d0ed7569..6db8fa398 100644 --- a/docs/atomate.qchem.fireworks.html +++ b/docs/atomate.qchem.fireworks.html @@ -4,7 +4,7 @@ -atomate.qchem.fireworks package — atomate 0.9.4 documentation +atomate.qchem.fireworks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -328,7 +328,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.html b/docs/atomate.qchem.html index 258e0a409..d730cb27a 100644 --- a/docs/atomate.qchem.html +++ b/docs/atomate.qchem.html @@ -4,7 +4,7 @@ -atomate.qchem package — atomate 0.9.4 documentation +atomate.qchem package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -317,7 +317,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.workflows.base.html b/docs/atomate.qchem.workflows.base.html index 70f34c82d..1f5432afd 100644 --- a/docs/atomate.qchem.workflows.base.html +++ b/docs/atomate.qchem.workflows.base.html @@ -4,7 +4,7 @@ -atomate.qchem.workflows.base package — atomate 0.9.4 documentation +atomate.qchem.workflows.base package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -271,7 +271,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.workflows.html b/docs/atomate.qchem.workflows.html index 8dddfa732..ce12b2d22 100644 --- a/docs/atomate.qchem.workflows.html +++ b/docs/atomate.qchem.workflows.html @@ -4,7 +4,7 @@ -atomate.qchem.workflows package — atomate 0.9.4 documentation +atomate.qchem.workflows package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -112,7 +112,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.qchem.workflows.tests.html b/docs/atomate.qchem.workflows.tests.html index 7d66b8c5f..1c090a80d 100644 --- a/docs/atomate.qchem.workflows.tests.html +++ b/docs/atomate.qchem.workflows.tests.html @@ -4,7 +4,7 @@ -atomate.qchem.workflows.tests package — atomate 0.9.4 documentation +atomate.qchem.workflows.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -173,7 +173,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.tools.html b/docs/atomate.tools.html index 6f0bb9400..a26e49c2f 100644 --- a/docs/atomate.tools.html +++ b/docs/atomate.tools.html @@ -4,7 +4,7 @@ -atomate.tools package — atomate 0.9.4 documentation +atomate.tools package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -110,7 +110,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.tools.post_process.html b/docs/atomate.tools.post_process.html index cc0af5b57..82fd59962 100644 --- a/docs/atomate.tools.post_process.html +++ b/docs/atomate.tools.post_process.html @@ -4,7 +4,7 @@ -atomate.tools.post_process package — atomate 0.9.4 documentation +atomate.tools.post_process package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -99,7 +99,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.tools.tests.html b/docs/atomate.tools.tests.html index 10a3c0b91..7c8f246bc 100644 --- a/docs/atomate.tools.tests.html +++ b/docs/atomate.tools.tests.html @@ -4,7 +4,7 @@ -atomate.tools.tests package — atomate 0.9.4 documentation +atomate.tools.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -95,7 +95,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.utils.html b/docs/atomate.utils.html index 5a40826e3..4a4544ade 100644 --- a/docs/atomate.utils.html +++ b/docs/atomate.utils.html @@ -4,7 +4,7 @@ -atomate.utils package — atomate 0.9.4 documentation +atomate.utils package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -511,7 +511,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.utils.tests.html b/docs/atomate.utils.tests.html index e7c963bf3..d63869069 100644 --- a/docs/atomate.utils.tests.html +++ b/docs/atomate.utils.tests.html @@ -4,7 +4,7 @@ -atomate.utils.tests package — atomate 0.9.4 documentation +atomate.utils.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -226,7 +226,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.vasp.analysis.html b/docs/atomate.vasp.analysis.html index 16bf70436..512cfc580 100644 --- a/docs/atomate.vasp.analysis.html +++ b/docs/atomate.vasp.analysis.html @@ -4,7 +4,7 @@ -atomate.vasp.analysis package — atomate 0.9.4 documentation +atomate.vasp.analysis package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -167,7 +167,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.vasp.builders.examples.html b/docs/atomate.vasp.builders.examples.html index 85cefe9d4..cc3944960 100644 --- a/docs/atomate.vasp.builders.examples.html +++ b/docs/atomate.vasp.builders.examples.html @@ -4,7 +4,7 @@ -atomate.vasp.builders.examples package — atomate 0.9.4 documentation +atomate.vasp.builders.examples package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -97,7 +97,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.vasp.builders.html b/docs/atomate.vasp.builders.html index 1ce051f16..74f0cca7e 100644 --- a/docs/atomate.vasp.builders.html +++ b/docs/atomate.vasp.builders.html @@ -4,7 +4,7 @@ -atomate.vasp.builders package — atomate 0.9.4 documentation +atomate.vasp.builders package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -585,7 +585,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.vasp.examples.html b/docs/atomate.vasp.examples.html index 7efbb5c3a..03fc57793 100644 --- a/docs/atomate.vasp.examples.html +++ b/docs/atomate.vasp.examples.html @@ -4,7 +4,7 @@ -atomate.vasp.examples package — atomate 0.9.4 documentation +atomate.vasp.examples package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -95,7 +95,7 @@Navigation
- modules |
- + diff --git a/docs/atomate.vasp.firetasks.html b/docs/atomate.vasp.firetasks.html index 03fec1ecf..fc4b2e5fe 100644 --- a/docs/atomate.vasp.firetasks.html +++ b/docs/atomate.vasp.firetasks.html @@ -4,7 +4,7 @@ -atomate.vasp.firetasks package — atomate 0.9.4 documentation +atomate.vasp.firetasks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- + @@ -45,6 +45,7 @@Subpackagesatomate.vasp.firetasks.tests package
@@ -416,6 +416,53 @@
- Submodules
- atomate.vasp.firetasks.tests.test_copy module
+- atomate.vasp.firetasks.tests.test_exchange module
- atomate.vasp.firetasks.tests.test_get_interpolated_poscar module
- atomate.vasp.firetasks.tests.test_polarization_to_db module
- atomate.vasp.firetasks.tests.test_write_vasp module
@@ -57,6 +58,266 @@Subpackages
Submodules¶
+ ++atomate.vasp.firetasks.exchange module¶
++
+ +- +class
+atomate.vasp.firetasks.exchange.
HeisenbergConvergence
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Quick check to see if the Heisenberg model has “converged” for any +particular nearest neighbor cutoff value in the sense that |J_ij| < |E_0| +for all i, j.
+If not, it doesn’t make sense to do Monte Carlo and the system is either +1) not well described by the Heisenberg Model (perhaps the magnetic +moments are not localized) or 2) not correctly captured by the provided +low-energy magnetic orderings.
++
+- Args:
- +
db_file (str): path to file containing the database credentials. +wf_uuid (int): Unique id for record keeping. +average (bool): <J> exchange param only.
+- TODO:
- +
+
+- +
More robust convergence check
+
+ +- +
+required_params
= ['db_file', 'wf_uuid', 'average']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
++
+ +- +class
+atomate.vasp.firetasks.exchange.
HeisenbergModelMapping
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Map structures and energies to a Heisenberg model and compute exchange +parameters for a given NN cutoff.
++
+- +
+
+- heisenberg_settings:
- +
cutoff (float): Starting point for nearest neighbor search. +tol (float): Tolerance for equivalent NN bonds.
++
+- Args:
- +
structures (list): Magnetic structures. +energies (list): Energies / atom (eV).
+- Optional parameters:
- +
+
+- heisenberg_settings (dict): A config dict for Heisenberg model
- +
mapping, detailed above.
++
+ +- +
+optional_params
= ['heisenberg_settings']¶+
+ +- +
+required_params
= ['structures', 'energies']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
++
+ +- +class
+atomate.vasp.firetasks.exchange.
HeisenbergModelToDb
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Insert Heisenberg Model object into a DB. Assumes you are in a +directory with a model written to a .json file.
++
+- Args:
- +
db_file (str): path to file containing the database credentials. +wf_uuid (int): Unique id for record keeping.
++
+ +- +
+required_params
= ['db_file', 'wf_uuid']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
++
+ +- +class
+atomate.vasp.firetasks.exchange.
VampireMC
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
If there is a suitable Heisenberg model, run Monte Carlo to compute the +critical temperature.
++
+- Args:
- +
db_file (str): path to file containing the database credentials. +wf_uuid (int): Unique id for record keeping.
+- Optional args:
- +
+
+- mc_settings (dict): A configuration dict for monte carlo.
- +
See pymatgen.command_line.VampireCaller for options.
+- TODO:
- +
+
+- +
Include HeisenbergModel convergence check.
+
+ +- +
+optional_params
= ['mc_settings']¶+
+ +- +
+required_params
= ['db_file', 'wf_uuid']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
++
+- +class
+atomate.vasp.firetasks.exchange.
VampireToDb
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Insert VAMPIRE output into DB.
+Assumes you are in a directory with output written to a .json.
++
+- Args:
- +
db_file (str): path to file containing the database credentials. +wf_uuid (int): Unique id for record keeping.
++
+ +- +
+required_params
= ['db_file', 'wf_uuid']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
+diff --git a/docs/atomate.vasp.fireworks.html b/docs/atomate.vasp.fireworks.html index 5310e0415..8c107f0de 100644 --- a/docs/atomate.vasp.fireworks.html +++ b/docs/atomate.vasp.fireworks.html @@ -4,7 +4,7 @@ -atomate.vasp.firetasks.glue_tasks module¶
@@ -893,39 +1154,41 @@Submodules -
- -class
+atomate.vasp.firetasks.parse_outputs.
MagneticDeformationToDB
(*args, **kwargs)¶- +class
atomate.vasp.firetasks.parse_outputs.
MagneticDeformationToDb
(*args, **kwargs)¶Bases:
fireworks.core.firework.FiretaskBase
Used to calculate magnetic deformation from get_wf_magnetic_deformation workflow. See docstring -for that workflow for more information. -Required parameters:
--+for that workflow for more information.db_file (str): path to the db file that holds your tasks -collection and that you want to hold the magnetic_orderings -collection -wf_uuid (str): auto-generated from get_wf_magnetic_orderings, -used to make it easier to retrieve task docs
--
- Optional parameters:
to_db (bool): if True, the data will be inserted into -dedicated collection in database, otherwise, will be dumped +
- Required parameters:
- +
+
+- db_file (str): path to the db file that holds your tasks
- +
collection and that you want to hold the magnetic_orderings +collection
+- wf_uuid (str): auto-generated from get_wf_magnetic_orderings,
- +
used to make it easier to retrieve task docs
+- Optional parameters:
- +
+
+- to_db (bool): if True, the data will be inserted into
dedicated collection in database, otherwise, will be dumped to a .json file.
-
- -
+run_task
(fw_spec)¶- +
run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a Firework spec, perform some task using that data, and then return an output in the form of a FWAction.
@@ -951,37 +1214,56 @@Submodules -
- -class
+atomate.vasp.firetasks.parse_outputs.
MagneticOrderingsToDB
(*args, **kwargs)¶- +class
atomate.vasp.firetasks.parse_outputs.
MagneticOrderingsToDb
(*args, **kwargs)¶Bases:
fireworks.core.firework.FiretaskBase
Used to aggregate tasks docs from magnetic ordering workflow. For large-scale/high-throughput use, would recommend a specific builder, this is intended for easy, automated use for calculating magnetic orderings directly from the get_wf_magnetic_orderings -workflow. It’s unlikely you will want to call this directly. -Required parameters:
+workflow. It’s unlikely you will want to call this directly. ++
- Required parameters:
- +
+
+- db_file (str): path to the db file that holds your tasks
- +
collection and that you want to hold the magnetic_orderings +collection
+- wf_uuid (str): auto-generated from get_wf_magnetic_orderings,
- +
used to make it easier to retrieve task docs
+- parent_structure (Structure): Structure of parent crystal (not
- +
magnetically ordered)
+perform_bader (bool): Perform Bader charge analysis. +scan (bool): Do static calcs with SCAN functional.
+- Optional parameters:
+
+- origins (list): str indicating transformations that generated
- +
orderings.
+input_index (int): index of input structure to enumerator. +to_db (bool): if True, the data will be inserted into
-db_file (str): path to the db file that holds your tasks -collection and that you want to hold the magnetic_orderings -collection -wf_uuid (str): auto-generated from get_wf_magnetic_orderings, -used to make it easier to retrieve task docs -parent_structure: Structure of parent crystal (not magnetically -ordered)
++dedicated collection in database, otherwise, will be dumped +to a .json file.
+
+ +- additional_fields (dict): fields added to the document such as
- +
user-defined tags or name, ids, etc
+-
- -
+optional_params
= ['origins', 'input_index']¶- +
optional_params
= ['origins', 'input_index', 'to_db', 'additional_fields']¶-
- -
+required_params
= ['db_file', 'wf_uuid', 'parent_structure', 'perform_bader', 'scan']¶- +
required_params
= ['db_file', 'wf_uuid', 'parent_structure', 'perform_bader', 'scan']¶-
- -
+run_task
(fw_spec)¶- +
run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a Firework spec, perform some task using that data, and then return an output in the form of a FWAction.
@@ -1176,6 +1458,8 @@Submodules
- -
+optional_params
= ['calc_dir', 'calc_loc', 'parse_dos', 'bandstructure_mode', 'additional_fields', 'db_file', 'fw_spec_field', 'defuse_unsuccessful', 'task_fields_to_push', 'parse_chgcar', 'parse_aeccar']¶optional_params
= ['calc_dir', 'calc_loc', 'parse_dos', 'bandstructure_mode', 'additional_fields', 'db_file', 'fw_spec_field', 'defuse_unsuccessful', 'task_fields_to_push', 'parse_chgcar', 'parse_aeccar', 'parse_potcar_file', 'store_volumetric_data']¶@@ -1456,12 +1740,13 @@
Submodules
- -
+optional_params
= ['params_to_check', 'check_incar', 'check_kpoints', 'check_poscar', 'check_potcar']¶optional_params
= ['params_to_check', 'check_incar', 'check_kpoints', 'check_poscar', 'check_potcar', 'clear_inputs']¶@@ -1499,7 +1784,7 @@
Submodules
atomate.vasp.firetasks.write_inputs module¶
-This module defines tasks for writing vasp input sets for various types of vasp calculations
+This module defines tasks for writing vasp input sets.
+
- class
@@ -1553,6 +1838,56 @@atomate.vasp.firetasks.write_inputs.
ModifyIncar
(*args, **kwargs)¶Submodules +
- +class
+atomate.vasp.firetasks.write_inputs.
ModifyKpoints
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Modify an KPOINTS file.
++
+- Required params:
- +
(none)
+- Optional params:
- +
+
+- kpoints_update (dict): overwrite Kpoint dict key. Supports env_chk.
- +
keys can be anything property of a kpoint object (kpts, kpts_shift, +kpts_weights, labels, comment, coord_type, num_kpts, +tet_connections, tet_number, tet_weight)
+input_filename (str): Input filename (if not “KPOINTS”) +output_filename (str): Output filename (if not “KPOINTS”)
++
+ +- +
+optional_params
= ['kpoints_update', 'input_filename', 'output_filename']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
++
- class
@@ -1603,13 +1938,65 @@atomate.vasp.firetasks.write_inputs.
ModifyPotcar
(*args, **kwargs)¶Submodules +
- +class
+atomate.vasp.firetasks.write_inputs.
UpdateScanRelaxBandgap
(*args, **kwargs)¶Bases:
+fireworks.core.firework.FiretaskBase
Writes input files for a SCAN relaxation by constructing a new input set. +The purpose of this Firetask is to allow the KSPACING and smearing parameters +to be recalculated based on the bandgap from the PBE relaxation in the +SCAN relaxation workflow. Assumes that output files from a previous +(e.g., optimization) run can be accessed in current dir or prev_calc_dir.
++
+- Optional params (dict):
- +
+
+- override_default_vasp_params: Dict of any keyword arguments supported
- +
by MPScanRelaxSet.
+- potcar_spec (bool): Instead of writing the POTCAR, write a
- +
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
++
+ +- +
+optional_params
= ['override_default_vasp_params', 'potcar_spec']¶+
+ +- +
+run_task
(fw_spec)¶This method gets called when the Firetask is run. It can take in a +Firework spec, perform some task using that data, and then return an +output in the form of a FWAction.
++
+- Args:
- +
+
+- fw_spec (dict): A Firework spec. This comes from the master spec.
- +
In addition, this spec contains a special “_fw_env” key that +contains the env settings of the FWorker calling this method. +This provides for abstracting out certain commands or +settings. For example, “foo” may be named “foo1” in resource +1 and “foo2” in resource 2. The FWorker env can specify { +“foo”: “foo1”}, which maps an abstract variable “foo” to the +relevant “foo1” or “foo2”. You can then write a task that +uses fw_spec[“_fw_env”][“foo”] that will work across all +these multiple resources.
+- Returns:
- +
(FWAction)
+
- class
atomate.vasp.firetasks.write_inputs.
WriteNormalmodeDisplacedPoscar
(*args, **kwargs)¶Bases:
-fireworks.core.firework.FiretaskBase
Displace the structure from the previous calculation along the provided normal mode by the -given amount and write the corresponding Poscar file. The fw_spec must contain a “normalmodes” -key with “eigenvecs” sub-key that is likely produced by a previous calc.
+Displace the structure from the previous calculation along the provided +normal mode by the given amount and write the corresponding Poscar file. +The fw_spec must contain a “normalmodes” key with “eigenvecs” sub-key that +is likely produced by a previous calc.
- Required params:
mode (int): normal mode index displacement (float): displacement along the normal mode in Angstroms
@@ -1652,28 +2039,37 @@Submodulesclass
atomate.vasp.firetasks.write_inputs.
WriteTransmutedStructureIOSet
(*args, **kwargs)¶Bases:
fireworks.core.firework.FiretaskBase
Apply the provided transformations to the input structure and write the -input set for that structure. Reads structure from POSCAR if no structure provided. Note that -if a transformation yields many structures from one, only the last structure in the list is -used.
+input set for that structure. Reads structure from POSCAR if no structure +provided. Note that if a transformation yields many structures from one, +only the last structure in the list is used.
- Required params:
structure (Structure): input structure -transformations (list): list of names of transformation classes as defined in
+transformations (list): list of names of transformation classes as-@@ -80,6 +80,26 @@the modules in pymatgen.transformations
+defined in the modules in pymatgen.transformations
vasp_input_set (VaspInputSet): VASP input set.
- Optional params:
-
- transformation_params (list): list of dicts where each dict specifies the input parameters
to instantiate the transformation class in the transformations list.
+- transformation_params (list): list of dicts where each dict specifies
the input parameters to instantiate the transformation class in the +transformations list.
override_default_vasp_params (dict): additional user input settings. -prev_calc_dir: path to previous calculation if using structure from another calculation.
+prev_calc_dir: path to previous calculation if using structure from +++another calculation.
++
- potcar_spec (bool): Instead of writing the POTCAR, write a
- +
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
+
- -
+optional_params
= ['prev_calc_dir', 'transformation_params', 'override_default_vasp_params']¶optional_params
= ['prev_calc_dir', 'transformation_params', 'override_default_vasp_params', 'potcar_spec']¶@@ -1712,27 +2108,33 @@
Submodules class
atomate.vasp.firetasks.write_inputs.
WriteVaspFromIOSet
(*args, **kwargs)¶Bases:
-fireworks.core.firework.FiretaskBase
Create VASP input files using implementations of pymatgen’s AbstractVaspInputSet. An input set -can be provided as an object or as a String/parameter combo.
+Create VASP input files using implementations of pymatgen’s +AbstractVaspInputSet. An input set can be provided as an object or as a +String/parameter combo.
- Required params:
structure (Structure): structure -vasp_input_set (AbstractVaspInputSet or str): Either a VaspInputSet object or a string
+vasp_input_set (AbstractVaspInputSet or str): Either a VaspInputSet-diff --git a/docs/atomate.vasp.firetasks.tests.html b/docs/atomate.vasp.firetasks.tests.html index 7bc314fc4..dd6d68166 100644 --- a/docs/atomate.vasp.firetasks.tests.html +++ b/docs/atomate.vasp.firetasks.tests.html @@ -4,7 +4,7 @@ -name for the VASP input set (e.g., “MPRelaxSet”).
+object or a string name for the VASP input set (e.g., “MPRelaxSet”).
- Optional params:
-
- vasp_input_params (dict): When using a string name for VASP input set, use this as a dict
to specify kwargs for instantiating the input set parameters. For example, if you want -to change the user_incar_settings, you should provide: {“user_incar_settings”: …}. -This setting is ignored if you provide the full object representation of a VaspInputSet -rather than a String.
+- vasp_input_params (dict): When using a string name for VASP input set,
- +
use this as a dict to specify kwargs for instantiating the input set +parameters. For example, if you want to change the +user_incar_settings, you should provide: +{“user_incar_settings”: …}. This setting is ignored if you provide +the full object representation of a VaspInputSet rather than a +String.
+- potcar_spec (bool): Instead of writing the POTCAR, write a
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
@@ -1785,20 +2187,28 @@
Submodules +
- vasp_input_set (str): a string name for the VASP input set (e.g.,
- +
“MPRelaxSet”).
+- Optional params:
-
- vasp_input_params (dict): When using a string name for VASP input set, use this as a dict
to specify kwargs for instantiating the input set parameters. For example, if you want -to change the user_incar_settings, you should provide: {“user_incar_settings”: …}. -This setting is ignored if you provide the full object representation of a VaspInputSet -rather than a String.
+- vasp_input_params (dict): When using a string name for VASP input set,
- +
use this as a dict to specify kwargs for instantiating the input set +parameters. For example, if you want to change the +user_incar_settings, you should provide: +{“user_incar_settings”: …}. This setting is ignored if you provide +the full object representation of a VaspInputSet rather than a +String.
+- potcar_spec (bool): Instead of writing the POTCAR, write a
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
- -
+optional_params
= ['vasp_input_params', 'autosort_tol']¶optional_params
= ['vasp_input_params', 'autosort_tol', 'potcar_spec']¶@@ -1838,9 +2248,9 @@
Submodulesclass
atomate.vasp.firetasks.write_inputs.
WriteVaspFromPMGObjects
(*args, **kwargs)¶Bases:
fireworks.core.firework.FiretaskBase
Write VASP files using pymatgen objects.
+Note, that although this firetask has no required params, it is +non-functional unless at least one optional param is set.
-
- Required params:
(none) - although non-functional unless you set one or more optional params
-- Optional params:
incar (Incar): pymatgen Incar object poscar (Poscar): pymatgen Poscar object kpoints (Kpoints): pymatgen Kpoints object @@ -1883,20 +2293,24 @@
Submodules class
atomate.vasp.firetasks.write_inputs.
WriteVaspHSEBSFromPrev
(*args, **kwargs)¶Bases:
-fireworks.core.firework.FiretaskBase
Writes input files for HSE band structure run. Assumes that output files from a -a previous job can be accessed. Since HSE always re-optimizes the charge density (no nSCF mode), -the previous job is used to get the location of VBM/CBM for mode=”gap” (otherwise just used to -get the structure / starting charge density).
--
- Required params:
(none)
+Writes input files for HSE band structure run. Assumes that output files +from a previous job can be accessed. Since HSE always re-optimizes the +charge density (no nSCF mode), the previous job is used to get the location +of VBM/CBM for mode=”gap” (otherwise just used to get the structure / +starting charge density).
++
- Optional params:
+
+- potcar_spec (bool): Instead of writing the POTCAR, write a
- -
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
- Optional params:
(documentation for all other optional params can be found in +
(documentation for all other optional params can be found in MPHSEBSSet)
- -
+optional_params
= ['prev_calc_dir', 'mode', 'reciprocal_density', 'kpoints_line_density']¶optional_params
= ['prev_calc_dir', 'mode', 'reciprocal_density', 'kpoints_line_density', 'potcar_spec']¶@@ -1941,15 +2355,24 @@
+Submodules +
- reciprocal_density (int): the reciprocal density for the kpoint mesh,
- +
defaults to 100
+other_params (dict) : any other params passed to MPNMRSet as a dict. +potcar_spec (bool): Instead of writing the POTCAR, write a
++-“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
reciprocol_density (int): the reciprocol density for the kpoint mesh, defaults to 100 -other_aprams (dict) : any other params passsed to MPNMRSet as a dictionary
- -
+optional_params
= ['mode', 'isotopes', 'reciprocal_density', 'other_params']¶optional_params
= ['prev_calc_dir', 'mode', 'isotopes', 'reciprocal_density', 'other_params', 'potcar_spec']¶@@ -1986,16 +2409,19 @@
Submodules -
- Required params:
(none)
++
- Optional params:
+
+- potcar_spec (bool): Instead of writing the POTCAR, write a
- -
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
- Optional params:
(documentation for all optional params can be found in +
(documentation for all optional params can be found in NonSCFVaspInputSet)
- -
+optional_params
= ['prev_calc_dir', 'copy_chgcar', 'nbands_factor', 'reciprocal_density', 'kpoints_line_density', 'small_gap_multiply', 'standardize', 'sym_prec', 'international_monoclinic', 'mode', 'nedos', 'optics', 'other_params']¶optional_params
= ['prev_calc_dir', 'copy_chgcar', 'nbands_factor', 'reciprocal_density', 'kpoints_line_density', 'small_gap_multiply', 'standardize', 'sym_prec', 'international_monoclinic', 'mode', 'nedos', 'optics', 'other_params', 'potcar_spec']¶@@ -2035,14 +2461,21 @@
Submodulesclass
atomate.vasp.firetasks.write_inputs.
WriteVaspSOCFromPrev
(*args, **kwargs)¶Bases:
fireworks.core.firework.FiretaskBase
Writes input files for a spinorbit coupling calculation.
-+
- Required params:
- +
magmom (list): magnetic moment values for each site in the structure. saxis (list): magnetic field direction
- Optional params:
+
+- potcar_spec (bool): Instead of writing the POTCAR, write a
- +
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
+(documentation for all optional params can be found in MPSOCSet)
+
- -
+optional_params
= ['prev_calc_dir', 'copy_chgcar', 'nbands_factor', 'reciprocal_density', 'small_gap_multiply', 'standardize', 'sym_prec', 'international_monoclinic', 'other_params']¶optional_params
= ['prev_calc_dir', 'copy_chgcar', 'nbands_factor', 'reciprocal_density', 'small_gap_multiply', 'standardize', 'sym_prec', 'international_monoclinic', 'other_params', 'potcar_spec']¶@@ -2081,19 +2514,22 @@
Submodules class
atomate.vasp.firetasks.write_inputs.
WriteVaspStaticFromPrev
(*args, **kwargs)¶Bases:
-fireworks.core.firework.FiretaskBase
Writes input files for a static run. Assumes that output files from a previous -(e.g., optimization) run can be accessed in current dir or prev_calc_dir. Also allows -lepsilon (dielectric constant) calcs.
--
- Required params:
(none)
+Writes input files for a static run. Assumes that output files from a +previous (e.g., optimization) run can be accessed in current dir or +prev_calc_dir. Also allows lepsilon (dielectric constant) calcs.
++
- Optional params:
+
+- potcar_spec (bool): Instead of writing the POTCAR, write a
- -
“POTCAR.spec”. This is intended to allow testing of workflows +without requiring pseudo-potentials to be installed on the system.
- Optional params:
(documentation for all other optional params can be found in +
(documentation for all other optional params can be found in MPStaticSet)
- -
+optional_params
= ['prev_calc_dir', 'reciprocal_density', 'small_gap_multiply', 'standardize', 'sym_prec', 'international_monoclinic', 'lepsilon', 'other_params']¶optional_params
= ['prev_calc_dir', 'reciprocal_density', 'small_gap_multiply', 'standardize', 'sym_prec', 'international_monoclinic', 'lepsilon', 'other_params', 'potcar_spec']¶@@ -2140,6 +2576,7 @@
Table of Contents
- atomate.vasp.firetasks package
atomate.vasp.firetasks.tests package — atomate 0.9.4 documentation +atomate.vasp.firetasks.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- +Submodules +
atomate.vasp.firetasks.tests.test_exchange module¶
++
+- +class
+atomate.vasp.firetasks.tests.test_exchange.
TestExchangeTasks
(methodName='runTest')¶Bases:
+atomate.utils.testing.AtomateTest
+
+ +- +classmethod
+setUpClass
()¶Hook method for setting up class fixture before running tests in the class.
++
+ +- +
+test_heisenberg_mm
()¶@@ -209,6 +239,7 @@atomate.vasp.firetasks.tests.test_get_interpolated_poscar module¶
@@ -160,6 +180,11 @@Submodulestest_modify_incar()¶ +
+
+- +
+test_modify_kpoints
()¶+
- @@ -170,6 +195,11 @@
test_modify_potcar
()¶Submodulestest_pmgobjects()¶
+
+- +
+test_potcar_spec
()¶Table of Contents
- atomate.vasp.firetasks.tests package
- Submodules
- atomate.vasp.firetasks.tests.test_copy module
+- atomate.vasp.firetasks.tests.test_exchange module
- atomate.vasp.firetasks.tests.test_get_interpolated_poscar module
- atomate.vasp.firetasks.tests.test_polarization_to_db module
- atomate.vasp.firetasks.tests.test_write_vasp module
@@ -248,7 +279,7 @@Navigation
- modules |
- +atomate.vasp.fireworks package — atomate 0.9.4 documentation +atomate.vasp.fireworks package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- +Submodules +
- +class
+atomate.vasp.fireworks.core.
ScanOptimizeFW
(structure, name='SCAN structure optimization', vasp_input_set=None, vasp_cmd='>>vasp_cmd<<', override_default_vasp_params=None, db_file='>>db_file<<', vdw_kernel_dir='>>vdw_kernel_dir<<', parents=None, **kwargs)¶Bases:
+fireworks.core.firework.Firework
+
+ +- +
+__init__
(structure, name='SCAN structure optimization', vasp_input_set=None, vasp_cmd='>>vasp_cmd<<', override_default_vasp_params=None, db_file='>>db_file<<', vdw_kernel_dir='>>vdw_kernel_dir<<', parents=None, **kwargs)¶Structure optimization using the SCAN metaGGA functional.
+This workflow performs a 3-step optmization. The first step (‘relax1’) +is a conventional GGA run relaxation that initializes the geometry and +calculates the bandgap of the structure. The bandgap is used to update +the KSPACING parameter, which sets the appropriate number of k-points +for the structure. The second step (‘.relax2’) is a static GGA +calculation that computes wavefunctions using the updated number of +k-points. The third step (‘relax3’) is a SCAN relaxation.
+By default, .relax1 and .relax2 are force converged with +EDIFFG = -0.05, and .relax3 is force converged with EDIFFG=-0.02.
++
+- Args:
- +
structure (Structure): Input structure. +name (str): Name for the Firework. +vasp_input_set (VaspInputSet): input set to use. Defaults to
+++MPScanRelaxSet() if None.
++
+- override_default_vasp_params (dict): If this is not None, and
- +
vasp_input_set is None, these params are passed to the default +vasp_input_set, i.e., MPScanRelaxSet. This allows one to easily +override some settings, e.g., bandgap, user_incar_settings, etc.
+vasp_cmd (str): Command to run vasp. Supports env_chk. +vdw_kernel_dir (str): Directory containing the pre-compiled VdW
+++kernel. Supports env_chk.
++
+- db_file (str): Path to file specifying db credentials to place
- +
output parsing. Supports env_chk.
+parents ([Firework]): Parents of this particular Firework. +**kwargs: Other kwargs that are passed to Firework.__init__.
+
atomate.vasp.fireworks.core.
StaticFW
(structure=None, name='static', vasp_input_set=None, vasp_input_set_params=None, vasp_cmd='>>vasp_cmd<<', prev_calc_loc=True, prev_calc_dir=None, db_file='>>db_file<<', vasptodb_kwargs=None, parents=None, **kwargs)¶atomate.vasp.fireworks.exchange.
HeisenbergModelFW
(wf_uuid, parent_structure, parents, db_file='>>db_file<<', heisenberg_settings=None, name='heisenberg model', structures=None, energies=None)¶Bases: fireworks.core.firework.Firework
__init__
(wf_uuid, parent_structure, parents, db_file='>>db_file<<', heisenberg_settings=None, name='heisenberg model', structures=None, energies=None)¶Takes a set of low-energy magnetic orderings and energies and maps +them to a Heisenberg Model to compute exchange params.
+cutoff (float): Starting point for nearest neighbor search. +tol (float): Tolerance for equivalent NN bonds.
+wf_uuid (int): Unique id for record keeping. +parent_structure (Structure): Magnetic ground state. +parents (FireWorks): Parent FWs. +db_file (str): Path to file containing db credentials. +heisenberg_settings (dict): A config dict for Heisenberg model
+++mapping, detailed above.
+
name (str): Labels the FW. +structures (list): Magnetic structures. +energies (list): Total energies of magnetic structures.
+Test a range of nn cutoffs and add convergence check.
atomate.vasp.fireworks.exchange.
VampireCallerFW
(wf_uuid, parent_structure, parents, db_file='>>db_file<<', mc_settings=None, name='vampire caller')¶Bases: fireworks.core.firework.Firework
__init__
(wf_uuid, parent_structure, parents, db_file='>>db_file<<', mc_settings=None, name='vampire caller')¶Run Vampire Monte Carlo from a HeisenbergModel.
+mc_box_size (float): MC simulation box size in nm. +equil_timesteps (int): Number of MC equilibration moves. +mc_timesteps (int): Number of MC moves for averaging. +avg (bool): Compute only <J>.
+wf_uuid (int): Unique id for record keeping. +parent_structure (Structure): Magnetic ground state. +parents (FireWorks): Parent FWs. +db_file (str): Path to file containing db credentials. +mc_settings (dict): A configuration dict for monte carlo. +name (str): Labels the FW.
+__init__
(structure, name='static dipole moment', static_name='static', vasp_cmd='vasp', vasp_input_set=None, vasp_input_set_params=None, db_file=None, parents=None, gap_threshold=0.01, interpolate=False, start=None, end=None, this_image=0, nimages=5, **kwargs)¶Static Firework that calculates the dipole moment of structure or a single interpolated image of structures -output by two calculations specified by PassCalcLoc names start and end.
-This Firework uses three steps to calculate the dipole moment. -1. A StaticFW or StaticInterpolatFW calculation is performed to compute the band gap of the structure. -2. Because VASP cannot compute the dipole moment of metallic structures, CheckBandgap checks that the structure -has a band gap greater than gap_threshold. If the structure has a band gap less than gap_threshold, -the Firework defuses. Otherwise, -3. a polarization calculation (LCALCPOL=TRUE) is performed to calculate the dipole moment.
-If interpolate is equal to True, the keywords start and end are PassCalcLoc names used to locate the output -structures (CONTCAR) of two previous calculations. These two structures must have the same number and -type of atoms given in identical order in the structures. These structures are used to create nimages structures -interpolations.
-this_image specifies which of the interpolated structures to use in this Firework. For example in the -ferroelectric workflow, two structures that can be distorted into one another (a -high-symmetry nonpolar structure and a low-symmetry polar structure) are relaxed using OptimizeFW. Then the -dipole moment is calculated for nimages intermediate structures generated by interpolating between these two -relaxed structures.
+Static Firework that calculates the dipole moment of structure or a +single interpolated image of structures output by two calculations +specified by PassCalcLoc names start and end.
+This Firework uses three steps to calculate the dipole moment.
+A StaticFW or StaticInterpolatFW calculation is performed to compute
++the band gap of the structure.
+
Because VASP cannot compute the dipole moment of metallic structures,
++CheckBandgap checks that the structure has a band gap greater than +gap_threshold. If the structure has a band gap less than +gap_threshold, the Firework defuses. Otherwise,
+
a polarization calculation (LCALCPOL=TRUE) is performed to calculate
++the dipole moment.
+
If interpolate is equal to True, the keywords start and end are +PassCalcLoc names used to locate the output structures (CONTCAR) of two +previous calculations. These two structures must have the same number +and type of atoms given in identical order in the structures. These +structures are used to create nimages structures interpolations.
+this_image specifies which of the interpolated structures to use in this +Firework. For example in the ferroelectric workflow, two structures that +can be distorted into one another (a high-symmetry nonpolar structure +and a low-symmetry polar structure) are relaxed using OptimizeFW. Then +the dipole moment is calculated for nimages intermediate structures +generated by interpolating between these two relaxed structures.
description.
+is a dummy structure. See interpolate arg description.
name (str): Name for the polarization FireWork. -static_name (str): Name for the SCF run to be used in PassCalcLoc if copy_vasp_outputs != True. -vasp_cmd (str): Command to run vasp. -vasp_input_set (str): string name for the VASP input set (e.g., “MITMDVaspInputSet”). -vasp_input_set_params (dict): Dict of vasp_input_set_kwargs. +static_name (str): Name for the SCF run to be used in PassCalcLoc
+++if copy_vasp_outputs != True.
+
vasp_cmd (str): Command to run vasp. +vasp_input_set (str): string name for the VASP input set (e.g.,
+++“MITMDVaspInputSet”).
+
vasp_input_set_params (dict): Dict of vasp_input_set_kwargs. db_file (str): Path to file specifying db credentials. -parents (Firework): Parents of this particular Firework. FW or list of FWS. -gap_threshold: Band gap cutoff for determining whether polarization calculation will proceed from
+parents (Firework): Parents of this particular Firework. FW or list-diff --git a/docs/atomate.vasp.html b/docs/atomate.vasp.html index 2da9fa4da..476f472cf 100644 --- a/docs/atomate.vasp.html +++ b/docs/atomate.vasp.html @@ -4,7 +4,7 @@ -SCF band gap.
+of FWS.
-
-- interpolate (bool): use structure created by interpolating CONTCAR structure from calculations indicated by
start and end PassCalcLoc names. If interpolate is False, start and end do not need to be set.
+- gap_threshold: Band gap cutoff for determining whether polarization
- +
calculation will proceed from SCF band gap.
+- interpolate (bool): use structure created by interpolating CONTCAR
- +
structure from calculations indicated by start and end +PassCalcLoc names. If interpolate is False, start and end do +not need to be set.
+- start (str): PassCalcLoc name of StaticFW or RelaxFW run of starting
- +
structure
+- end (str): PassCalcLoc name of StaticFW or RelaxFW run of ending
- +
structure
+- this_image (int): which interpolation to use for this run of the
- +
nimage interpolations.
+- nimages (int): number of interpolations between CONTCAR structures
from calculations indicated by start and end args.
start (str): PassCalcLoc name of StaticFW or RelaxFW run of starting structure -end (str): PassCalcLoc name of StaticFW or RelaxFW run of ending structure -this_image (int): which interpolation to use for this run of the nimage interpolations. -nimages (int): number of interpolations between CONTCAR structures from calculations indicated by start and
--@@ -640,6 +788,7 @@end args.
-Table of Contents
- atomate.vasp.fireworks package
atomate.vasp package — atomate 0.9.4 documentation +atomate.vasp package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- +
atomate.vasp.drones.
VaspDrone
(runs=None, parse_dos='auto', bandstructure_mode='auto', parse_locpot=True, additional_fields=None, use_full_uri=True, parse_bader=None, parse_chgcar=False, parse_aeccar=False)¶atomate.vasp.drones.
VaspDrone
(runs=None, parse_dos='auto', bandstructure_mode='auto', parse_locpot=True, additional_fields=None, use_full_uri=True, parse_bader=None, parse_chgcar=False, parse_aeccar=False, parse_potcar_file=True, store_volumetric_data=('chgcar', 'aeccar0', 'aeccar2', 'elfcar', 'locpot'), store_additional_json=False)¶
Bases: pymatgen.apps.borg.hive.AbstractDrone
pymatgen-db VaspToDbTaskDrone with updated schema and documents processing methods. Please refer to matgendb.creator.VaspToDbTaskDrone documentation.
__init__
(runs=None, parse_dos='auto', bandstructure_mode='auto', parse_locpot=True, additional_fields=None, use_full_uri=True, parse_bader=None, parse_chgcar=False, parse_aeccar=False)¶__init__
(runs=None, parse_dos='auto', bandstructure_mode='auto', parse_locpot=True, additional_fields=None, use_full_uri=True, parse_bader=None, parse_chgcar=False, parse_aeccar=False, parse_potcar_file=True, store_volumetric_data=('chgcar', 'aeccar0', 'aeccar2', 'elfcar', 'locpot'), store_additional_json=False)¶
Initialize a Vasp drone to parse vasp outputs Args:
@@ -328,7 +333,11 @@Submodulesprocess_bandstructure(vrun)¶
process_chgcar
(chg_file)¶process_dos
(vrun)¶atomate.vasp.powerups.
add_additional_fields_to_taskdocs
(original_wf, update_dict=None, task_name_constraint='VaspToDb')¶For all VaspToDbTasks in a given workflow, add information to “additional_fields” to be -placed in the task doc.
+For all VaspToDbTasks in a given workflow, add information to +“additional_fields” to be placed in the task doc.
original_wf (Workflow) -update_dict (Dict): dictionary to add additional_fields
+update_dict (Dict): dictionary to add additional_fields +task_name_constraint (str): name of the Firetasks to be modified.Workflow
atomate.vasp.powerups.
add_bandgap_check
(original_wf, check_bandgap_params=None, fw_name_constraint=None)¶Every FireWork that enters into the Db has a band gap check afterwards, e.g. min_gap and max_gap
-Every FireWork that enters into the Db has a band gap check afterwards, +e.g. min_gap and max_gap
+original_wf (Workflow) -check_bandgap_params (dict): a kwargs style dict of params, e.g. min_gap or max_gap -fw_name_constraint (str) - Only apply changes to FWs where fw_name contains this substring.
+check_bandgap_params (dict): a kwargs style dict of params, e.g. +++min_gap or max_gap
+
contains this substring.
+Workflow
atomate.vasp.powerups.
add_common_powerups
(wf, c=None)¶Apply the common powerups such as add_namefile, use_scratch_dir etc. from the given config dict.
+Apply the common powerups such as add_namefile, use_scratch_dir etc. from +the given config dict.
wf (Workflow) c (dict): Config dict
@@ -522,12 +535,14 @@atomate.vasp.powerups.
add_modify_incar
(original_wf, modify_incar_params=None, fw_name_constraint=None)¶Every FireWork that runs VASP has a ModifyIncar task just beforehand. For example, allows -you to modify the INCAR based on the Worker using env_chk or using hard-coded changes.
+Every FireWork that runs VASP has a ModifyIncar task just beforehand. For +example, allows you to modify the INCAR based on the Worker using env_chk or +using hard-coded changes.
original_wf (Workflow) modify_incar_params (dict) - dict of parameters for ModifyIncar. -fw_name_constraint (str) - Only apply changes to FWs where fw_name contains this substring.
+fw_name_constraint (str) - Only apply changes to FWs where fw_name +contains this substring.Workflow
atomate.vasp.powerups.
add_modify_incar_envchk
(original_wf, fw_name_constraint=None)¶If you set the “incar_update” parameter in the Worker env, the INCAR will update this -parameter for all matching VASP runs
+If you set the “incar_update” parameter in the Worker env, the INCAR will +update this parameter for all matching VASP runs
+original_wf (Workflow) +fw_name_constraint (str) - Only apply changes to FWs where fw_name
+++contains this substring.
+
Workflow
+atomate.vasp.powerups.
add_modify_kpoints
(original_wf, modify_kpoints_params=None, fw_name_constraint=None)¶Every FireWork that runs VASP has a ModifyKpoints task just beforehand. For +example, allows you to modify the KPOINTS based on the Worker using env_chk +or using hard-coded changes.
original_wf (Workflow) -fw_name_constraint (str) - Only apply changes to FWs where fw_name contains this substring.
+modify_kpoints_params (dict): dict of parameters for ModifyKpoints. +fw_name_constraint (str): Only apply changes to FWs where fw_name +contains this substring.Workflow
atomate.vasp.powerups.
add_modify_potcar
(original_wf, modify_potcar_params=None, fw_name_constraint=None)¶Every FireWork that runs VASP has a ModifyIncar task just beforehand. For example, allows -you to modify the INCAR based on the Worker using env_chk or using hard-coded changes.
-Every FireWork that runs VASP has a ModifyIncar task just beforehand. For +example, allows you to modify the INCAR based on the Worker using env_chk or +using hard-coded changes.
+original_wf (Workflow) -modify_incar_params (dict) - dict of parameters for ModifyIncar. -fw_name_constraint (str) - Only apply changes to FWs where fw_name contains this substring.
+modify_potcar_params (dict) - dict of parameters for ModifyPotcar. +fw_name_constraint (str) - Only apply changes to FWs where fw_name ++contains this substring.
+
Workflow
atomate.vasp.powerups.
add_priority
(original_wf, root_priority, child_priority=None)¶
Adds priority to a workflow
-original_wf (Workflow): original WF root_priority (int): priority of first (root) job(s) -child_priority(int): priority of all child jobs. Defaults to root_priority
+child_priority(int): priority of all child jobs. Defaults to ++root_priority
+
Workflow: priority-decorated workflow
atomate.vasp.powerups.
add_small_gap_multiply
(original_wf, gap_cutoff, density_multiplier, fw_name_constraint=None)¶In all FWs with specified name constraints, add a ‘small_gap_multiply’ parameter that -multiplies the k-mesh density of compounds with gap < gap_cutoff by density multiplier. -Useful for increasing the k-point mesh for metallic or small gap systems. -Note that this powerup only works on FireWorks with the appropriate WriteVasp* tasks that -accept the small_gap_multiply argument…
-In all FWs with specified name constraints, add a ‘small_gap_multiply’ +parameter that multiplies the k-mesh density of compounds with gap < +gap_cutoff by density multiplier. Useful for increasing the k-point mesh for +metallic or small gap systems. Note that this powerup only works on +FireWorks with the appropriate WriteVasp* tasks that accept the +small_gap_multiply argument…
+original_wf (Workflow) -gap_cutoff (float): Only multiply k-points for materials with gap < gap_cutoff (eV) -density_multiplier (float): Multiply k-point density by this amount -fw_name_constraint (str): Only apply changes to FWs where fw_name contains this substring.
+gap_cutoff (float): Only multiply k-points for materials with gap < +++gap_cutoff (eV)
+
density_multiplier (float): Multiply k-point density by this amount +fw_name_constraint (str): Only apply changes to FWs where fw_name
++contains this substring.
+
Workflow
atomate.vasp.powerups.
add_stability_check
(original_wf, check_stability_params=None, fw_name_constraint=None)¶Every FireWork that enters into the Db has a CheckStability task afterward. This -allows defusing jobs that are not stable. In practice, you might want +
Every FireWork that enters into the Db has a CheckStability task afterward. +This allows defusing jobs that are not stable. In practice, you might want to set the fw_name_constraint so that the stability is only checked at the beginning of the workflow
-original_wf (Workflow) check_stability_params (dict): a kwargs style dict of params -fw_name_constraint (str) - Only apply changes to FWs where fw_name contains this substring.
+fw_name_constraint (str) - Only apply changes to FWs where fw_name ++contains this substring.
+
Workflow
Adds tags to all Fireworks in the Workflow, WF metadata, as well as additional_fields for -the VaspDrone to track them later (e.g. all fireworks and vasp tasks related to a research project)
+Adds tags to all Fireworks in the Workflow, WF metadata, as well as +additional_fields for the VaspDrone to track them later (e.g. all fireworks +and vasp tasks related to a research project)
original_wf (Workflow) tags_list: list of tags parameters (list of strings)
@@ -645,7 +698,8 @@atomate.vasp.powerups.
add_trackers
(original_wf, tracked_files=None, nlines=25)¶Every FireWork that runs VASP also tracks the OUTCAR, OSZICAR, etc using FWS Trackers.
+Every FireWork that runs VASP also tracks the OUTCAR, OSZICAR, etc using FWS +Trackers.
original_wf (Workflow) tracked_files (list) : list of files to be tracked @@ -672,11 +726,13 @@
atomate.vasp.powerups.
clean_up_files
(original_wf, files=('WAVECAR*', ), fw_name_constraint=None, task_name_constraint='RunVasp')¶Cleans up files after another fireworks. Default behavior is to remove WAVECAR after running VASP
-WAVECAR after running VASP.
+original_wf (Workflow) files (list): list of patterns to match for files to clean up -fw_name_constraint (str): pattern for firetask to clean up files after
+fw_name_constraint (str): pattern for fireworks to clean up files after +task_name_constraint (str): pattern for firetask to clean up filesWorkflow
atomate.vasp.powerups.
clear_modify
(original_wf, fw_name_constraint=None)¶
Simple powerup that clears the modifications to a workflow.
-have their modification tasks removed
-original_wf (Workflow): The original workflow. +fw_name_constraint (str): name constraint for fireworks to
++have their modification tasks removed
+
atomate.vasp.powerups.
modify_to_soc
(original_wf, nbands, structure=None, modify_incar_params=None, fw_name_constraint=None)¶Takes a regular workflow and transforms its VASP fireworkers that are specified with -fw_name_constraints to non-collinear calculations taking spin orbit coupling into account.
-original_wf (Workflow) +
Takes a regular workflow and transforms its VASP fireworkers that are +specified with fw_name_constraints to non-collinear calculations taking spin +orbit coupling into account.
+original_wf (Workflow): The original workflow. nbands (int): number of bands selected by the user (for now) structure (Structure) -modify_incar_params ({}): a dictionary containing the setting for modyfining the INCAR (e.g. {“ICHARG”: 11}) -fw_name_constraint (string): name of the fireworks to be modified (all if None is passed)
+modify_incar_params ({}): a dictionary containing the setting for +++modifying the INCAR (e.g. {“ICHARG”: 11})
+
if None is passed)
+Workflow: modified with SOC
atomate.vasp.powerups.
preserve_fworker
(original_wf, fw_name_constraint=None)¶set _preserve_fworker spec of Fireworker(s) of a Workflow. Can be used to pin a workflow to -the first fworker it is run with. Very useful when running on multiple machines that can’t -share files. fw_name_constraint can be used to only preserve fworker after a certain point -where file passing becomes important
+set _preserve_fworker spec of Fireworker(s) of a Workflow. Can be used to +pin a workflow to the first fworker it is run with. Very useful when running +on multiple machines that can’t share files. fw_name_constraint can be used +to only preserve fworker after a certain point where file passing becomes +important
original_wf (Workflow): -fw_name_constraint (str): name of the Fireworks to be tagged (all if None is passed)
+fw_name_constraint (str): name of the Fireworks to be tagged (all if +None is passed)Workflow: modified workflow with specified Fireworkers tagged
atomate.vasp.powerups.
remove_custodian
(original_wf, fw_name_constraint=None)¶Replaces all tasks with “RunVasp*” (e.g. RunVaspCustodian) to be RunVaspDirect.
-Replaces all tasks with “RunVasp*” (e.g. RunVaspCustodian) to be +RunVaspDirect.
+original_wf (Workflow): original workflow -fw_name_constraint (str): Only apply changes to FWs where fw_name contains this substring.
+fw_name_constraint (str): Only apply changes to FWs where fw_name ++contains this substring.
+
Workflow
atomate.vasp.powerups.
set_execution_options
(original_wf, fworker_name=None, category=None, fw_name_constraint=None, task_name_constraint=None)¶set _fworker spec of Fireworker(s) of a Workflow. It can be used to specify a queue; -e.g. run large-memory jobs on a separate queue.
+set _fworker spec of Fireworker(s) of a Workflow. It can be used to specify +a queue; e.g. run large-memory jobs on a separate queue.
original_wf (Workflow): fworker_name (str): user-defined tag to be added under fw.spec._fworker
@@ -769,30 +839,67 @@None or ‘RunVasp’)
+Workflow: modified workflow with specified Fireworkers tagged
atomate.vasp.powerups.
set_queue_options
(original_wf, walltime=None, time_min=None, qos=None, fw_name_constraint=None, task_name_constraint=None)¶Modify queue submission parameters of Fireworks in a Workflow.
+This powerup overrides paramters in the qadapter file by setting values in +the ‘queueadapter’ key of a Firework spec. For example, the walltime +requested from a queue can be modified on a per-workflow basis.
+original_wf (Workflow): +walltime (str): Total walltime to request for the job in HH:MM:SS
+++format e.g., “00:10:00” for 10 minutes.
+
Specifying both walltime and time_min can improve throughput on +some queues.
+“flex”, and “scavenger”. For Cori KNL “flex” QoS, it is necessary +to specify a time_min of no more than 2 hours.
+None is passed)
+None or ‘RunVasp’)
+Workflow: workflow with modified queue options
+atomate.vasp.powerups.
use_custodian
(original_wf, fw_name_constraint=None, custodian_params=None)¶Replaces all tasks with “RunVasp*” (e.g. RunVaspDirect) to be RunVaspCustodian. Thus, this -powerup adds error correction into VASP runs if not originally present and/or modifies -the correction behavior.
+Replaces all tasks with “RunVasp*” (e.g. RunVaspDirect) to be +RunVaspCustodian. Thus, this powerup adds error correction into VASP runs if +not originally present and/or modifies the correction behavior.
original_wf (Workflow): original workflow -fw_name_constraint (str): Only apply changes to FWs where fw_name contains this substring.
+fw_name_constraint (str): Only apply changes to FWs where fw_name-diff --git a/docs/atomate.vasp.tests.html b/docs/atomate.vasp.tests.html index 76bd0b5c8..494d19377 100644 --- a/docs/atomate.vasp.tests.html +++ b/docs/atomate.vasp.tests.html @@ -4,7 +4,7 @@ -For example, use custodian only for certain runs, or set job_type to -“double_relaxation_run” only for structure optimization run, or set different -handler_group for different runs.
+contains this substring. For example, use custodian only for certain +runs, or set job_type to “double_relaxation_run” only for structure +optimization run, or set different handler_group for different runs.
-
@@ -803,13 +910,22 @@- custodian_params (dict): A dict of parameters for RunVaspCustodian. e.g., use it to set
a “scratch_dir” or “handler_group”.
+- custodian_params (dict): A dict of parameters for RunVaspCustodian.
e.g., use it to set a “scratch_dir” or “handler_group”.
Submodules
- -
-atomate.vasp.powerups.
use_fake_vasp
(original_wf, ref_dirs, params_to_check=None)¶Replaces all tasks with “RunVasp” (e.g. RunVaspDirect) to be RunVaspFake. Thus, we do not -actually run VASP but copy pre-determined inputs and outputs.
-+
atomate.vasp.powerups.
use_fake_vasp
(original_wf, ref_dirs, params_to_check=None, check_incar=True, check_kpoints=True, check_poscar=True, check_potcar=True, clear_inputs=True)¶ +Replaces all tasks with “RunVasp” (e.g. RunVaspDirect) to be RunVaspFake. +Thus, we do not actually run VASP but copy pre-determined inputs and +outputs.
+
- Args:
original_wf (Workflow) -ref_dirs (dict): key=firework name, value=path to the reference vasp calculation directory -params_to_check (list): optional list of incar parameters to check.
+ref_dirs (dict): key=firework name, value=path to the reference vasp +++calculation directory
+params_to_check (list): optional list of incar parameters to check. +check_incar (bool): whether to confirm the INCAR params. +check_kpoints (bool): whether to confirm the KPOINTS params. +check_poscar (bool): whether to confirm the POSCAR params. +check_potcar (bool): whether to confirm the POTCAR params. +clear_inputs (bool): whether to delete VASP input files after running.
- Returns:
- @@ -832,11 +948,42 @@
Workflow
Submodules
- -
atomate.vasp.powerups.
use_no_vasp
(original_wf, ref_dirs)¶Instead of running VASP, does nothing and pass task documents from task.json files in ref_dirs -to task database.
-+
+ +Instead of running VASP, does nothing and pass task documents from task.json +files in ref_dirs to task database.
++
- Args:
- +
original_wf (Workflow) -ref_dirs(dict): key=firework name, value=path to the reference vasp calculation directory
+ref_dirs(dict): key=firework name, value=path to the reference vasp +++calculation directory
+- Returns:
- +
Workflow
++
- +
+atomate.vasp.powerups.
use_potcar_spec
(original_wf, fw_name_constraint=None, vasp_to_db_kwargs=None)¶In all WriteVasp tasks, enable the potcar_spec option. In this mode, +POTCAR files will be written as POTCAR.spec files, containing only the +atomic symbols. Furthermore, POTCAR files will not be parsed by the +VaspToDb drone.
+The primary use case for this powerup is to enable easier testing of +atomate workflows. Typically, writing VaspInputSets requires having the +VASP pseudopotentials installed. Due to licensing restraints, the +VASP pseudopotentials are not installed in the atomate testing environment. +Use of this powerup therefore enables testing of atomate workflows in the +absence of installed pseudopotentials.
+Note: this powerup should also be combined with RunFakeVasp with +check_potcar set to False.
++
- Args:
original_wf (Workflow) +fw_name_constraint (str): Only apply changes to FWs where fw_name
+++contains this substring.
+vasp_to_db_kwargs (dict): Additional kwargs to pass to VaspToDb.
- Returns:
- @@ -900,6 +1047,8 @@
Workflow
Submodulestest(structure)¶
Method to execute the test.
+
- Args:
structure (Structure): Input structure to test
+- Returns:
- @@ -973,7 +1122,7 @@
(bool) Structures that return true are kept in the Transmuter object during filtering.
Navigation
- modules |
- +atomate.vasp.tests package — atomate 0.9.4 documentation +atomate.vasp.tests package — atomate 0.9.5 documentation @@ -27,7 +27,7 @@Navigation
- modules |
- +
test_parse_potcar
()¶test_runs_assimilate
()¶test_modify_kpoints
()¶test_modify_potcar
()¶test_queue_options
()¶test_use_potcar_spec
()¶test_use_scratch_dir
()¶atomate.vasp.tests.test_vasp_powerups.
copy_wf
(wf)¶atomate.vasp.workflows.base.exchange.
ExchangeWF
(magnetic_structures, energies, default_magmoms=None, db_file='>>db_file<<', name='Exchange WF')¶Bases: object
__init__
(magnetic_structures, energies, default_magmoms=None, db_file='>>db_file<<', name='Exchange WF')¶Workflow for computing exchange parameters.
+This workflow takes a set of magnetic orderings and their energies +from MagneticOrderingsWF and fits to a classical Heisenberg +Hamiltonian to compute exchange parameters. The critical temperature +can then be calculated with Monte Carlo.
+Optionally, only the lowest energy FM and AFM configurations can be +used to compute the average exchange interaction, <J>, without any +static calculations.
+site property.
+energies (list): Energies per atom in eV. +default_magmoms (dict): (optional, defaults provided) dict of
+++magnetic elements to their initial magnetic moments in µB, +generally these are chosen to be high-spin since they can +relax to a low-spin configuration during a DFT electronic +configuration.
+
db_file (string): Path to database file. +name (string): Name of workflow.
+get_wf
(num_orderings_hard_limit=16, c=None)¶Retrieve Fireworks workflow.
+c is an optional dictionary that can contain: +* heisenberg_settings:
+++cutoff (float): Starting point for nearest neighbor search. +tol (float): Tolerance for equivalent NN bonds.
+
mc_box_size (float): MC simulation box size in nm. +equil_timesteps (int): Number of MC equilibration moves. +mc_timesteps (int): Number of MC moves for averaging. +avg (bool): Compute only <J>.
+path to db.json.
+magnetic orderings does not exceed this number even if there +are extra orderings of equivalent symmetry
+c Optional[dict]: additional config dict described above
+wf (Workflow): Heisenberg Model + Vampire Monte Carlo.
+Add static SCAN option (only optimization is available)
atomate.vasp.workflows.base.magnetism.
MagneticOrderingsWF
(structure, default_magmoms=None, strategies=('ferromagnetic', 'antiferromagnetic'), automatic=True, truncate_by_symmetry=True, transformation_kwargs=None)¶atomate.vasp.workflows.base.magnetism.
MagneticOrderingsWF
(structure, default_magmoms=None, strategies=('ferromagnetic', 'antiferromagnetic'), automatic=True, truncate_by_symmetry=True, transformation_kwargs=None, static=False)¶
Bases: object
__init__
(structure, default_magmoms=None, strategies=('ferromagnetic', 'antiferromagnetic'), automatic=True, truncate_by_symmetry=True, transformation_kwargs=None)¶__init__
(structure, default_magmoms=None, strategies=('ferromagnetic', 'antiferromagnetic'), automatic=True, truncate_by_symmetry=True, transformation_kwargs=None, static=False)¶
This workflow will try several different collinear magnetic orderings for a given input structure, and output a summary to a dedicated database @@ -448,7 +529,7 @@
We make a note of the input structure, and then sanitize it (make it ferromagnetic, primitive)
transformation_kwargs: keyword arguments to pass to
+from: ferromagnetic, antiferromagnetic, +antiferromagnetic_by_motif, ferrimagnetic_by_motif and +ferrimagnetic_by_species (here, “motif”, +means to use a different ordering parameter for symmetry +inequivalent sites)
+strategies
+unsymmetrical orderings that are likely physically implausible
+MagOrderingTransformation, to change automatic cell size +limits, etc.
+different magnetic orderings in a fixed ground state +geometry.
+MagOrderingTransformation, to change automatic cell size limits, etc.
get_wf
(scan=False, perform_bader=True, num_orderings_hard_limit=16, c=None)¶Retrieve the FireWorks workflow.
-scan: if True, use the SCAN functional instead of GGA+U, since
+since the SCAN functional has shown to have improved +performance for magnetic systems in some cases
+your path, will use Bader analysis to calculate +atom-projected magnetic moments
+magnetic orderings does not exceed this number even if there +are extra orderings of equivalent symmetry
+c (dict): additional config dict (as used elsewhere in atomate)
the SCAN functional has shown to have improved performance for -magnetic systems in some cases
---perform_bader: if True, make sure the “bader” binary is in your
-
path, will use Bader analysis to calculate atom-projected magnetic -moments
---num_orderings_hard_limit: will make sure total number of magnetic
-
orderings does not exceed this number even if there are extra orderings -of equivalent symmetry
--c: additional config dict (as used elsewhere in atomate)
-
Returns: FireWorks Workflow
atomate.vasp.workflows.base.magnetism.
get_commensurate_orderings
(magnetic_structures, energies)¶Generate supercells for static calculations.
+From the ground state magnetic ordering and first excited state, +generate supercells with magnetic orderings.
+If the gs is FM, match supercells to the 1st es. +If the gs is AFM, FM is included by default, 1st es may not be. +If the gs is FiM, 1st es may not be captured.
+magnetic_structures (list): Structures. +energies (list): Energies per atom.
+calculations.
+Only consider orderings with |S_i| = ground state
Constrain noncollinear magmoms
atomate.vasp.workflows.base.magnetism.
get_wf_magnetic_deformation
(structure, c=None, vis=None)¶atomate.vasp.workflows.presets.scan.
wf_scan_opt
(structure, c=None)¶Structure optimization using the SCAN metaGGA functional.
+This workflow performs a 2-step optmization. The first step +is a conventional GGA run and serves to precondition the geometry and +wavefunctions. The second step is a SCAN structure optimization.
+The first optimization is force converged with EDIFFG = -0.05, +and the second optimization is force converged with EDIFFG=-0.02.
+atomate.vasp.workflows.tests.test_exchange_workflow.
TestExchangeWF
(methodName='runTest')¶Bases: atomate.utils.testing.AtomateTest
setUpClass
()¶Hook method for setting up class fixture before running tests in the class.
+test_workflow
()¶atomate.utils.testing.AtomateTest
setUp
()¶setUp
(lpad=True)¶
Create scratch directory(removes the old one if there is one) and change to it. Also initialize launchpad.
tearDown
()¶Remove the scratch directory and teardown the test db.
+test_wf
()¶untarTestFiles
()¶atomate.vasp.workflows.tests.test_ferroelectric_workflow.
delete_folder
(path)¶atomate.vasp.workflows.tests.test_ferroelectric_workflow.
get_simulated_wf
(wf)¶atomate.vasp.workflows.tests.test_ferroelectric_workflow.
untar_test_files
()¶atomate.vasp.workflows.tests.test_neb_workflow.
get_simulated_wf
(wf)¶atomate.vasp.workflows.tests.test_vasp_workflows.
TestScanOptimizeWorkflow
(methodName='runTest')¶Bases: atomate.utils.testing.AtomateTest
setUp
()¶Create scratch directory(removes the old one if there is one) and change to it. +Also initialize launchpad.
+test_SCAN_incar_override
()¶test_SCAN_large_bandgap
()¶test_SCAN_no_bandgap
()¶test_SCAN_small_bandgap
()¶test_SCAN_with_vdw
()¶atomate.vasp.workflows.tests.test_vasp_workflows.
TestVaspWorkflows
(methodName='runTest')¶v0.9.5
+Add magnetism workflow (M. Horton, N. Frey)
Overhaul SCAN workflow (R. Kingsbury)
Move help to Discourse (A. Ganose)
add ModifyKPoints Firetask (M. Siron)
Misc fixes, dependency updates, and improvements (M. Horton, N. Frey, A. Jain, M. Siron, A. Ganose)
v0.9.4
Fixes for new pymatgen (S. Blau, S.P. Ong)
Alireza Faghaninia, Alex Dunn, Alex Ganose, and Evan Spotte-Smith through the research group of A. Jain at LBNL.
Kiran Mathew, Shyam Dwaraknath, Joey Montoya, Murat Aykol, Patrick Huck, Brandon Wood, Sam Blau, Jimmy Shen, Anne Rutt, Eric Sivonxay, and Martin Siron through the research group of Prof. Kristin Persson at UC Berkeley.
Kiran Mathew, Shyam Dwaraknath, Joey Montoya, Murat Aykol, Matt Horton, Patrick Huck, Brandon Wood, Sam Blau, Jimmy Shen, Ryan Kingsbury, Anne Rutt, Eric Sivonxay, and Martin Siron through the research group of Prof. Kristin Persson at UC Berkeley.
Hanmei Tang, Prof. Shyue Ping Ong, and the Materials Virtual Lab research group at UC San Diego.
Brandon Bocklund, who led the atomate documentation effort, through the research group of Prof. Zi-Kiu Liu at Penn State.
Tess Smidt through the research group of Prof. Jeff Neaton at UC Berkeley.
Danny Broberg through the research group of Prof. Mark Asta at UC Berkeley.
External contributors: specter119, M. Dias Costa, S. Torrisi, Max Dylla, Marnik Bercx, Tara Maria Boland
External contributors: specter119, M. Dias Costa, S. Torrisi, Max Dylla, Marnik Bercx, Tara Maria Boland, Nathan Frey, Martin Siron