From 5f65a63c6a8bcb8b92cafacf2e4a052f3fe33d2e Mon Sep 17 00:00:00 2001
From: Shyue Ping Ong
Date: Sat, 22 Jul 2023 08:21:13 -0700
Subject: [PATCH] Update dev docs
---
custodian/__init__.py | 2 +-
docs/_modules/custodian/ansible/actions.html | 4 +-
.../custodian/ansible/interpreter.html | 4 +-
.../custodian/cli/converge_geometry.html | 4 +-
.../custodian/cli/converge_kpoints.html | 4 +-
docs/_modules/custodian/cli/cstdn.html | 4 +-
docs/_modules/custodian/cli/run_nwchem.html | 4 +-
docs/_modules/custodian/cli/run_vasp.html | 4 +-
docs/_modules/custodian/cp2k/handlers.html | 4 +-
docs/_modules/custodian/cp2k/interpreter.html | 4 +-
docs/_modules/custodian/cp2k/jobs.html | 4 +-
docs/_modules/custodian/cp2k/utils.html | 4 +-
docs/_modules/custodian/cp2k/validators.html | 4 +-
docs/_modules/custodian/custodian.html | 26 +++++---
docs/_modules/custodian/feff/handlers.html | 4 +-
docs/_modules/custodian/feff/interpreter.html | 4 +-
docs/_modules/custodian/feff/jobs.html | 4 +-
docs/_modules/custodian/lobster/handlers.html | 4 +-
docs/_modules/custodian/lobster/jobs.html | 4 +-
docs/_modules/custodian/nwchem/handlers.html | 4 +-
docs/_modules/custodian/nwchem/jobs.html | 4 +-
docs/_modules/custodian/qchem/utils.html | 4 +-
docs/_modules/custodian/utils.html | 4 +-
docs/_modules/custodian/vasp/handlers.html | 31 ++++++----
docs/_modules/custodian/vasp/interpreter.html | 4 +-
docs/_modules/custodian/vasp/jobs.html | 58 ++++++++++--------
docs/_modules/custodian/vasp/validators.html | 4 +-
docs/_modules/index.html | 4 +-
docs/_static/documentation_options.js | 2 +-
docs/_themes/README.html | 6 +-
docs/changelog.html | 15 ++++-
docs/custodian.ansible.html | 6 +-
docs/custodian.cli.html | 6 +-
docs/custodian.cp2k.html | 6 +-
docs/custodian.feff.html | 6 +-
docs/custodian.html | 6 +-
docs/custodian.lobster.html | 6 +-
docs/custodian.nwchem.html | 6 +-
docs/custodian.qchem.html | 6 +-
docs/custodian.vasp.html | 34 +++++-----
docs/genindex.html | 4 +-
docs/index.html | 6 +-
docs/modules.html | 6 +-
docs/objects.inv | Bin 2444 -> 2445 bytes
docs/py-modindex.html | 4 +-
docs/search.html | 4 +-
docs/searchindex.js | 2 +-
setup.py | 2 +-
48 files changed, 187 insertions(+), 159 deletions(-)
diff --git a/custodian/__init__.py b/custodian/__init__.py
index 2b52b201..3d5d2987 100644
--- a/custodian/__init__.py
+++ b/custodian/__init__.py
@@ -4,6 +4,6 @@
"""
__author__ = "Shyue Ping Ong, William Davidson Richards, Stephen Dacek, Xiaohui Qu, Matthew Horton, Samuel M. Blau"
-__version__ = "2023.6.5"
+__version__ = "2023.7.22"
from .custodian import Custodian
diff --git a/docs/_modules/custodian/ansible/actions.html b/docs/_modules/custodian/ansible/actions.html
index 1122caaa..02371ebe 100644
--- a/docs/_modules/custodian/ansible/actions.html
+++ b/docs/_modules/custodian/ansible/actions.html
@@ -4,7 +4,7 @@
- custodian.ansible.actions — custodian 2023.6.5 documentation
+ custodian.ansible.actions — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.ansible.actions
diff --git a/docs/_modules/custodian/ansible/interpreter.html b/docs/_modules/custodian/ansible/interpreter.html
index 4a9b74b3..deb06965 100644
--- a/docs/_modules/custodian/ansible/interpreter.html
+++ b/docs/_modules/custodian/ansible/interpreter.html
@@ -4,7 +4,7 @@
- custodian.ansible.interpreter — custodian 2023.6.5 documentation
+ custodian.ansible.interpreter — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.ansible.interpreter
diff --git a/docs/_modules/custodian/cli/converge_geometry.html b/docs/_modules/custodian/cli/converge_geometry.html
index 3514eac6..72230282 100644
--- a/docs/_modules/custodian/cli/converge_geometry.html
+++ b/docs/_modules/custodian/cli/converge_geometry.html
@@ -4,7 +4,7 @@
- custodian.cli.converge_geometry — custodian 2023.6.5 documentation
+ custodian.cli.converge_geometry — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cli.converge_geometry
diff --git a/docs/_modules/custodian/cli/converge_kpoints.html b/docs/_modules/custodian/cli/converge_kpoints.html
index c3df5d80..75b9c3aa 100644
--- a/docs/_modules/custodian/cli/converge_kpoints.html
+++ b/docs/_modules/custodian/cli/converge_kpoints.html
@@ -4,7 +4,7 @@
- custodian.cli.converge_kpoints — custodian 2023.6.5 documentation
+ custodian.cli.converge_kpoints — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cli.converge_kpoints
diff --git a/docs/_modules/custodian/cli/cstdn.html b/docs/_modules/custodian/cli/cstdn.html
index 46e20943..34804a45 100644
--- a/docs/_modules/custodian/cli/cstdn.html
+++ b/docs/_modules/custodian/cli/cstdn.html
@@ -4,7 +4,7 @@
- custodian.cli.cstdn — custodian 2023.6.5 documentation
+ custodian.cli.cstdn — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cli.cstdn
diff --git a/docs/_modules/custodian/cli/run_nwchem.html b/docs/_modules/custodian/cli/run_nwchem.html
index 7c345b91..1e1a42c4 100644
--- a/docs/_modules/custodian/cli/run_nwchem.html
+++ b/docs/_modules/custodian/cli/run_nwchem.html
@@ -4,7 +4,7 @@
- custodian.cli.run_nwchem — custodian 2023.6.5 documentation
+ custodian.cli.run_nwchem — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cli.run_nwchem
diff --git a/docs/_modules/custodian/cli/run_vasp.html b/docs/_modules/custodian/cli/run_vasp.html
index 254cb50e..a6354126 100644
--- a/docs/_modules/custodian/cli/run_vasp.html
+++ b/docs/_modules/custodian/cli/run_vasp.html
@@ -4,7 +4,7 @@
- custodian.cli.run_vasp — custodian 2023.6.5 documentation
+ custodian.cli.run_vasp — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cli.run_vasp
diff --git a/docs/_modules/custodian/cp2k/handlers.html b/docs/_modules/custodian/cp2k/handlers.html
index d88d9f84..edb613e6 100644
--- a/docs/_modules/custodian/cp2k/handlers.html
+++ b/docs/_modules/custodian/cp2k/handlers.html
@@ -4,7 +4,7 @@
- custodian.cp2k.handlers — custodian 2023.6.5 documentation
+ custodian.cp2k.handlers — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cp2k.handlers
diff --git a/docs/_modules/custodian/cp2k/interpreter.html b/docs/_modules/custodian/cp2k/interpreter.html
index 8a310d48..1f52a561 100644
--- a/docs/_modules/custodian/cp2k/interpreter.html
+++ b/docs/_modules/custodian/cp2k/interpreter.html
@@ -4,7 +4,7 @@
- custodian.cp2k.interpreter — custodian 2023.6.5 documentation
+ custodian.cp2k.interpreter — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cp2k.interpreter
diff --git a/docs/_modules/custodian/cp2k/jobs.html b/docs/_modules/custodian/cp2k/jobs.html
index 236b5672..2c71dd72 100644
--- a/docs/_modules/custodian/cp2k/jobs.html
+++ b/docs/_modules/custodian/cp2k/jobs.html
@@ -4,7 +4,7 @@
- custodian.cp2k.jobs — custodian 2023.6.5 documentation
+ custodian.cp2k.jobs — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cp2k.jobs
diff --git a/docs/_modules/custodian/cp2k/utils.html b/docs/_modules/custodian/cp2k/utils.html
index 8f39a764..6390be36 100644
--- a/docs/_modules/custodian/cp2k/utils.html
+++ b/docs/_modules/custodian/cp2k/utils.html
@@ -4,7 +4,7 @@
- custodian.cp2k.utils — custodian 2023.6.5 documentation
+ custodian.cp2k.utils — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cp2k.utils
diff --git a/docs/_modules/custodian/cp2k/validators.html b/docs/_modules/custodian/cp2k/validators.html
index 1267e102..285eb1b6 100644
--- a/docs/_modules/custodian/cp2k/validators.html
+++ b/docs/_modules/custodian/cp2k/validators.html
@@ -4,7 +4,7 @@
- custodian.cp2k.validators — custodian 2023.6.5 documentation
+ custodian.cp2k.validators — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.cp2k.validators
diff --git a/docs/_modules/custodian/custodian.html b/docs/_modules/custodian/custodian.html
index 05fecd6d..9680eda7 100644
--- a/docs/_modules/custodian/custodian.html
+++ b/docs/_modules/custodian/custodian.html
@@ -4,7 +4,7 @@
- custodian.custodian — custodian 2023.6.5 documentation
+ custodian.custodian — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
Module code »
custodian.custodian
@@ -99,7 +99,7 @@ Source code for custodian.custodian
if SENTRY_DSN :
import sentry_sdk
- sentry_sdk . init ( dsn = SENTRY_DSN )
+ sentry_sdk . init ( dsn = SENTRY_DSN ) # pylint: disable=E0110
with sentry_sdk . configure_scope () as scope :
from getpass import getuser
@@ -507,6 +507,11 @@ Source code for custodian.custodian
has_error = False
zero_return_code = True
+ # Choose the terminate function to run. If a terminate_func exists, this
+ # should take priority, followed by Job.terminate if implemented, and finally
+ # subprocess.Popen.terminate if neither of the former exist.
+ terminate = self . terminate_func or job . terminate or p . terminate
+
# While the job is running, we use the handlers that are
# monitors to monitor the job.
if isinstance ( p , subprocess . Popen ):
@@ -515,13 +520,18 @@ Source code for custodian.custodian
while True :
n += 1
time . sleep ( self . polling_time_step )
+ # We poll the process p to check if it is still running.
+ # Note that the process here is not the actual calculation
+ # but whatever is used to control the execution of the
+ # calculation executable. For instance; mpirun, srun, and so on.
if p . poll () is not None :
break
- terminate = self . terminate_func or p . terminate
if n % self . monitor_freq == 0 :
+ # At every self.polling_time_step * self.monitor_freq seconds,
+ # we check the job for errors using handlers that are monitors.
+ # In order to properly kill a running calculation, we use
+ # the appropriate implementation of terminate.
has_error = self . _do_check ( self . monitors , terminate )
- if terminate is not None and terminate != p . terminate :
- time . sleep ( self . polling_time_step )
else :
p . wait ()
if self . terminate_func is not None and self . terminate_func != p . terminate :
@@ -539,10 +549,6 @@ Source code for custodian.custodian
else :
has_error = self . _do_check ( self . handlers )
- if has_error :
- # This makes sure the job is killed cleanly for certain systems.
- job . terminate ()
-
# If there are no errors detected, perform
# postprocessing and exit.
if not has_error :
diff --git a/docs/_modules/custodian/feff/handlers.html b/docs/_modules/custodian/feff/handlers.html
index 559c4768..639dd260 100644
--- a/docs/_modules/custodian/feff/handlers.html
+++ b/docs/_modules/custodian/feff/handlers.html
@@ -4,7 +4,7 @@
- custodian.feff.handlers — custodian 2023.6.5 documentation
+ custodian.feff.handlers — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.feff.handlers
diff --git a/docs/_modules/custodian/feff/interpreter.html b/docs/_modules/custodian/feff/interpreter.html
index c948c7ea..bc822f56 100644
--- a/docs/_modules/custodian/feff/interpreter.html
+++ b/docs/_modules/custodian/feff/interpreter.html
@@ -4,7 +4,7 @@
-
custodian.feff.interpreter — custodian 2023.6.5 documentation
+
custodian.feff.interpreter — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.feff.interpreter
diff --git a/docs/_modules/custodian/feff/jobs.html b/docs/_modules/custodian/feff/jobs.html
index bf91d13d..1c3f9b52 100644
--- a/docs/_modules/custodian/feff/jobs.html
+++ b/docs/_modules/custodian/feff/jobs.html
@@ -4,7 +4,7 @@
-
custodian.feff.jobs — custodian 2023.6.5 documentation
+
custodian.feff.jobs — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.feff.jobs
diff --git a/docs/_modules/custodian/lobster/handlers.html b/docs/_modules/custodian/lobster/handlers.html
index e6c99456..dc9933d3 100644
--- a/docs/_modules/custodian/lobster/handlers.html
+++ b/docs/_modules/custodian/lobster/handlers.html
@@ -4,7 +4,7 @@
-
custodian.lobster.handlers — custodian 2023.6.5 documentation
+
custodian.lobster.handlers — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.lobster.handlers
diff --git a/docs/_modules/custodian/lobster/jobs.html b/docs/_modules/custodian/lobster/jobs.html
index cd6ce5f3..52842388 100644
--- a/docs/_modules/custodian/lobster/jobs.html
+++ b/docs/_modules/custodian/lobster/jobs.html
@@ -4,7 +4,7 @@
-
custodian.lobster.jobs — custodian 2023.6.5 documentation
+
custodian.lobster.jobs — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.lobster.jobs
diff --git a/docs/_modules/custodian/nwchem/handlers.html b/docs/_modules/custodian/nwchem/handlers.html
index 5ae1282f..6744c956 100644
--- a/docs/_modules/custodian/nwchem/handlers.html
+++ b/docs/_modules/custodian/nwchem/handlers.html
@@ -4,7 +4,7 @@
-
custodian.nwchem.handlers — custodian 2023.6.5 documentation
+
custodian.nwchem.handlers — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.nwchem.handlers
diff --git a/docs/_modules/custodian/nwchem/jobs.html b/docs/_modules/custodian/nwchem/jobs.html
index 964bb900..b9099f8b 100644
--- a/docs/_modules/custodian/nwchem/jobs.html
+++ b/docs/_modules/custodian/nwchem/jobs.html
@@ -4,7 +4,7 @@
-
custodian.nwchem.jobs — custodian 2023.6.5 documentation
+
custodian.nwchem.jobs — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.nwchem.jobs
diff --git a/docs/_modules/custodian/qchem/utils.html b/docs/_modules/custodian/qchem/utils.html
index 3f7e09f3..eeb595c3 100644
--- a/docs/_modules/custodian/qchem/utils.html
+++ b/docs/_modules/custodian/qchem/utils.html
@@ -4,7 +4,7 @@
-
custodian.qchem.utils — custodian 2023.6.5 documentation
+
custodian.qchem.utils — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.qchem.utils
diff --git a/docs/_modules/custodian/utils.html b/docs/_modules/custodian/utils.html
index 12a4131f..942ec306 100644
--- a/docs/_modules/custodian/utils.html
+++ b/docs/_modules/custodian/utils.html
@@ -4,7 +4,7 @@
-
custodian.utils — custodian 2023.6.5 documentation
+
custodian.utils — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.utils
diff --git a/docs/_modules/custodian/vasp/handlers.html b/docs/_modules/custodian/vasp/handlers.html
index 6f8f2201..f0b2a39e 100644
--- a/docs/_modules/custodian/vasp/handlers.html
+++ b/docs/_modules/custodian/vasp/handlers.html
@@ -4,7 +4,7 @@
-
custodian.vasp.handlers — custodian 2023.6.5 documentation
+
custodian.vasp.handlers — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.vasp.handlers
@@ -172,21 +172,21 @@
Source code for custodian.vasp.handlers
default redirect used by :class:`custodian.vasp.jobs.VaspJob`.
errors_subset_to_detect (list): A subset of errors to catch. The
default is None, which means all supported errors are detected.
- Use this to only catch only a subset of supported errors.
- E.g., ["eddrrm", "zheev"] will only catch the eddrmm and zheev
- errors, and not others. If you wish to only excluded one or
+ Use this to catch only a subset of supported errors.
+ E.g., ["eddrmm", "zheev"] will only catch the eddrmm and zheev
+ errors, and not others. If you wish to only exclude one or
two of the errors, you can create this list by the following
lines:
- vtst_fixes (bool): Whether to consider VTST optimizers. Defaults to
- False for compatibility purposes, but if you have VTST, you
- would likely benefit from setting this to True.
```
- subset = list(VaspErrorHandler.error_msgs.keys())
- subset.pop("eddrrm")
+ subset = list(VaspErrorHandler().error_msgs.keys())
+ subset.remove("eddrmm")
handler = VaspErrorHandler(errors_subset_to_catch=subset)
```
+ vtst_fixes (bool): Whether to consider VTST optimizers. Defaults to
+ False for compatibility purposes, but if you have VTST, you
+ would likely benefit from setting this to True.
"""
self . output_filename = output_filename
self . errors = set ()
@@ -1299,7 +1299,7 @@ Source code for custodian.vasp.handlers
# Can't perform check if Outcar not valid
return False
- if incar . get ( "ISMEAR" , 0 ) > 0 :
+ if incar . get ( "ISMEAR" , 1 ) > 0 :
# Read the latest entropy term.
outcar . read_pattern (
{ "entropy" : r "entropy T\*S.*= *(\D\d*\.\d*)" }, postprocess = float , reverse = True , terminate_on_match = True
@@ -1333,6 +1333,15 @@ Source code for custodian.vasp.handlers
"action" : { "_set" : { "SIGMA" : sigma - 0.06 }},
}
)
+ else :
+ # https://vasp.at/wiki/index.php/ISMEAR recommends ISMEAR = 0 if you have
+ # no a priori knowledge of your system ("then always use Gaussian smearing"
+ actions . append (
+ {
+ "dict" : "INCAR" ,
+ "action" : { "_set" : { "ISMEAR" : 0 , "SIGMA" : 0.05 }},
+ }
+ )
VaspModder ( vi = vi ) . apply_actions ( actions )
return { "errors" : [ "LargeSigma" ], "actions" : actions }
diff --git a/docs/_modules/custodian/vasp/interpreter.html b/docs/_modules/custodian/vasp/interpreter.html
index d6bf14ee..284dcb6d 100644
--- a/docs/_modules/custodian/vasp/interpreter.html
+++ b/docs/_modules/custodian/vasp/interpreter.html
@@ -4,7 +4,7 @@
- custodian.vasp.interpreter — custodian 2023.6.5 documentation
+ custodian.vasp.interpreter — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.vasp.interpreter
diff --git a/docs/_modules/custodian/vasp/jobs.html b/docs/_modules/custodian/vasp/jobs.html
index 02430177..d3877ec8 100644
--- a/docs/_modules/custodian/vasp/jobs.html
+++ b/docs/_modules/custodian/vasp/jobs.html
@@ -4,7 +4,7 @@
-
custodian.vasp.jobs — custodian 2023.6.5 documentation
+
custodian.vasp.jobs — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.vasp.jobs
@@ -187,7 +187,7 @@
Source code for custodian.vasp.jobs
wall-time handler which will write a read-only STOPCAR to
prevent VASP from deleting it once it finishes
"""
- self . vasp_cmd = vasp_cmd
+ self . vasp_cmd = tuple ( vasp_cmd )
self . output_file = output_file
self . stderr_file = stderr_file
self . final = final
@@ -196,7 +196,7 @@ Source code for custodian.vasp.jobs
self . settings_override = settings_override
self . auto_npar = auto_npar
self . auto_gamma = auto_gamma
- self . gamma_vasp_cmd = gamma_vasp_cmd
+ self . gamma_vasp_cmd = tuple ( gamma_vasp_cmd ) if gamma_vasp_cmd else None
self . copy_magmom = copy_magmom
self . auto_continue = auto_continue
@@ -294,7 +294,7 @@ Source code for custodian.vasp.jobs
kpts = vi [ "KPOINTS" ]
if kpts is not None :
if kpts . style == Kpoints . supported_modes . Gamma and tuple ( kpts . kpts [ 0 ]) == ( 1 , 1 , 1 ):
- if self . gamma_vasp_cmd is not None and which ( self . gamma_vasp_cmd [ - 1 ]):
+ if self . gamma_vasp_cmd is not None and which ( self . gamma_vasp_cmd [ - 1 ]): # pylint: disable=E1136
cmd = self . gamma_vasp_cmd
elif which ( cmd [ - 1 ] + ".gamma" ):
cmd [ - 1 ] += ".gamma"
@@ -713,35 +713,39 @@ Source code for custodian.vasp.jobs
[docs] def terminate ( self ):
"""
-
Kill all vasp processes associated with the current job.
+
Kill all VASP processes associated with the current job.
This is done by looping over all processes and selecting the ones
-
that contain "vasp" as well as access files (CHGCAR in particular)
+
that contain "vasp" as well as access files (vasprun.xml in particular)
in the custodian working directory.
-
There is also a safety that kills all vasp processes if non of the
-
processes can be killed (This is bad if more than one vasp runs are
+
There is also a safety that kills all VASP processes if none of the
+
processes can be killed (This is bad if more than one VASP runs are
simultaneously executed on the same node). However, this should never
happen.
"""
workdir = os . getcwd ()
-
logger . info ( f "kill vasp processes in work dir { workdir } " )
-
is_killed = False
+
logger . info ( f "Killing VASP processes in workdir { workdir } ." )
for proc in psutil . process_iter ():
try :
if "vasp" in proc . name () . lower ():
-
for file in proc . open_files ():
-
if workdir + "/CHGCAR" == file . path and psutil . pid_exists ( proc . pid ):
-
proc . kill ()
-
is_killed = True
-
except ( psutil . NoSuchProcess , psutil . AccessDenied ):
+
open_paths = [ file . path for file in proc . open_files ()]
+
vasprun_path = os . path . join ( workdir , "vasprun.xml" )
+
if ( vasprun_path in open_paths ) and psutil . pid_exists ( proc . pid ):
+
proc . kill ()
+
return
+
except ( psutil . NoSuchProcess , psutil . AccessDenied ) as e :
+
logger . warning ( f "Exception { e } encountered while killing VASP." )
continue
-
if not is_killed :
-
logger . warning ( f "killing vasp processes in work dir { workdir } failed. Resorting to 'killall'." )
-
cmds = self . vasp_cmd
-
if self . gamma_vasp_cmd :
-
cmds += self . gamma_vasp_cmd
-
for k in cmds :
-
if "vasp" in k :
-
subprocess . run ([ "killall" , f " { k } " ])
+
+ logger . warning (
+ f "Killing VASP processes in workdir { workdir } failed with subprocess.Popen.terminate(). "
+ "Resorting to 'killall'."
+ )
+ cmds = self . vasp_cmd
+ if self . gamma_vasp_cmd :
+ cmds += self . gamma_vasp_cmd
+ for k in cmds :
+ if "vasp" in k :
+ subprocess . run ([ "killall" , f " { k } " ])
[docs] class VaspNEBJob ( VaspJob ):
@@ -818,7 +822,7 @@
Source code for custodian.vasp.jobs
"action": {"_file_copy": {"dest": "POSCAR"}}}]
"""
- self . vasp_cmd = vasp_cmd
+ self . vasp_cmd = tuple ( vasp_cmd )
self . output_file = output_file
self . stderr_file = stderr_file
self . final = final
@@ -827,7 +831,7 @@ Source code for custodian.vasp.jobs
self . auto_npar = auto_npar
self . half_kpts = half_kpts
self . auto_gamma = auto_gamma
- self . gamma_vasp_cmd = gamma_vasp_cmd
+ self . gamma_vasp_cmd = tuple ( gamma_vasp_cmd ) if gamma_vasp_cmd else None
self . auto_continue = auto_continue
self . settings_override = settings_override
self . neb_dirs = [] # 00, 01, etc.
@@ -912,7 +916,7 @@ Source code for custodian.vasp.jobs
1 ,
1 ,
):
- if self . gamma_vasp_cmd is not None and which ( self . gamma_vasp_cmd [ - 1 ]):
+ if self . gamma_vasp_cmd is not None and which ( self . gamma_vasp_cmd [ - 1 ]): # pylint: disable=E1136
cmd = self . gamma_vasp_cmd
elif which ( cmd [ - 1 ] + ".gamma" ):
cmd [ - 1 ] += ".gamma"
diff --git a/docs/_modules/custodian/vasp/validators.html b/docs/_modules/custodian/vasp/validators.html
index 4fadd22b..5ab0e63a 100644
--- a/docs/_modules/custodian/vasp/validators.html
+++ b/docs/_modules/custodian/vasp/validators.html
@@ -4,7 +4,7 @@
- custodian.vasp.validators — custodian 2023.6.5 documentation
+ custodian.vasp.validators — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Module code »
custodian.vasp.validators
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
index b80690f1..951ff1ca 100644
--- a/docs/_modules/index.html
+++ b/docs/_modules/index.html
@@ -4,7 +4,7 @@
-
Overview: module code — custodian 2023.6.5 documentation
+
Overview: module code — custodian 2023.7.22 documentation
@@ -34,7 +34,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Overview: module code
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index fedca7e5..88af4a35 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: '2023.6.5',
+ VERSION: '2023.7.22',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/docs/_themes/README.html b/docs/_themes/README.html
index 2f828bc4..c14eb38c 100644
--- a/docs/_themes/README.html
+++ b/docs/_themes/README.html
@@ -3,9 +3,9 @@
-
+
- krTheme Sphinx Style — custodian 2023.6.5 documentation
+ krTheme Sphinx Style — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
krTheme Sphinx Style
diff --git a/docs/changelog.html b/docs/changelog.html
index c374d8b1..5b53aeb0 100644
--- a/docs/changelog.html
+++ b/docs/changelog.html
@@ -3,9 +3,9 @@
-
+
- Change Log — custodian 2023.6.5 documentation
+ Change Log — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
Change Log
@@ -47,6 +47,14 @@
Navigation
Change Log
+
+v2023.7.22
+
+Fix for LargeSigmaHandler. Now defaults to ISMEAR=1 and fallback to ISMEAR=0 if SIGMA has been modified
+three times from 0.2 (@arosen93, @janosh)
+More robust VASP job termination (@fyalcin)
+
+
v2023.6.5
@@ -470,6 +478,7 @@ Version 0.2.4
diff --git a/docs/custodian.cli.html b/docs/custodian.cli.html
index 32c3d4c1..6647a427 100644
--- a/docs/custodian.cli.html
+++ b/docs/custodian.cli.html
@@ -3,9 +3,9 @@
-
+
- custodian.cli package — custodian 2023.6.5 documentation
+ custodian.cli package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
custodian.cli package
diff --git a/docs/custodian.cp2k.html b/docs/custodian.cp2k.html
index 6a632c9a..88619f00 100644
--- a/docs/custodian.cp2k.html
+++ b/docs/custodian.cp2k.html
@@ -3,9 +3,9 @@
-
+
-
custodian.cp2k package — custodian 2023.6.5 documentation
+
custodian.cp2k package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
custodian.cp2k package
diff --git a/docs/custodian.feff.html b/docs/custodian.feff.html
index ad775918..40094e33 100644
--- a/docs/custodian.feff.html
+++ b/docs/custodian.feff.html
@@ -3,9 +3,9 @@
-
+
-
custodian.feff package — custodian 2023.6.5 documentation
+
custodian.feff package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@
Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
custodian.feff package
diff --git a/docs/custodian.html b/docs/custodian.html
index d91a0a47..c0c330f6 100644
--- a/docs/custodian.html
+++ b/docs/custodian.html
@@ -3,9 +3,9 @@
-
+
- custodian package — custodian 2023.6.5 documentation
+ custodian package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
custodian package
diff --git a/docs/custodian.lobster.html b/docs/custodian.lobster.html
index 2c54a678..1d6f8d5c 100644
--- a/docs/custodian.lobster.html
+++ b/docs/custodian.lobster.html
@@ -3,9 +3,9 @@
-
+
- custodian.lobster package — custodian 2023.6.5 documentation
+ custodian.lobster package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
custodian.lobster package
diff --git a/docs/custodian.nwchem.html b/docs/custodian.nwchem.html
index 64b3f716..6c48838b 100644
--- a/docs/custodian.nwchem.html
+++ b/docs/custodian.nwchem.html
@@ -3,9 +3,9 @@
-
+
- custodian.nwchem package — custodian 2023.6.5 documentation
+ custodian.nwchem package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
-
custodian 2023.6.5 documentation »
+
custodian 2023.7.22 documentation »
custodian.nwchem package
diff --git a/docs/custodian.qchem.html b/docs/custodian.qchem.html
index 7857182f..9260f5c5 100644
--- a/docs/custodian.qchem.html
+++ b/docs/custodian.qchem.html
@@ -3,9 +3,9 @@
-
+
- custodian.qchem package — custodian 2023.6.5 documentation
+ custodian.qchem package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
custodian.qchem package
diff --git a/docs/custodian.vasp.html b/docs/custodian.vasp.html
index 9b15aef9..1f763f00 100644
--- a/docs/custodian.vasp.html
+++ b/docs/custodian.vasp.html
@@ -3,9 +3,9 @@
-
+
- custodian.vasp package — custodian 2023.6.5 documentation
+ custodian.vasp package — custodian 2023.7.22 documentation
@@ -35,7 +35,7 @@ Navigation
modules |
- custodian 2023.6.5 documentation »
+ custodian 2023.7.22 documentation »
custodian.vasp package
@@ -724,22 +724,22 @@ Submodules.
-errors_subset_to_detect (list ) – A subset of errors to catch. The
+
errors_subset_to_detect (list ) –
A subset of errors to catch. The
default is None, which means all supported errors are detected.
-Use this to only catch only a subset of supported errors.
-E.g., [“eddrrm”, “zheev”] will only catch the eddrmm and zheev
-errors, and not others. If you wish to only excluded one or
+Use this to catch only a subset of supported errors.
+E.g., [“eddrmm”, “zheev”] will only catch the eddrmm and zheev
+errors, and not others. If you wish to only exclude one or
two of the errors, you can create this list by the following
-lines:
-vtst_fixes (bool ) –
Whether to consider VTST optimizers. Defaults to
-False for compatibility purposes, but if you have VTST, you
-would likely benefit from setting this to True.
+lines:
`` `
-subset = list(VaspErrorHandler.error_msgs.keys())
-subset.pop(“eddrrm”)
+subset = list(VaspErrorHandler().error_msgs.keys())
+subset.remove(“eddrmm”)
handler = VaspErrorHandler(errors_subset_to_catch=subset)
`` `
+vtst_fixes (bool ) – Whether to consider VTST optimizers. Defaults to
+False for compatibility purposes, but if you have VTST, you
+would likely benefit from setting this to True.
@@ -1152,12 +1152,12 @@ Submodules