Skip to content

Commit

Permalink
Update dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shyue Ping Ong committed May 7, 2023
1 parent 5ec3819 commit a058337
Show file tree
Hide file tree
Showing 51 changed files with 11,349 additions and 375 deletions.
2 changes: 1 addition & 1 deletion custodian/__init__.py
View file
Expand Up @@ -4,6 +4,6 @@
"""

__author__ = "Shyue Ping Ong, William Davidson Richards, Stephen Dacek, Xiaohui Qu, Matthew Horton, Samuel M. Blau"
__version__ = "2023.3.10"
__version__ = "2023.5.7"

from .custodian import Custodian
5 changes: 2 additions & 3 deletions docs/_modules/custodian/ansible/actions.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.ansible.actions &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.ansible.actions &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.ansible.actions</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/ansible/interpreter.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.ansible.interpreter &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.ansible.interpreter &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.ansible.interpreter</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cli/converge_geometry.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cli.converge_geometry &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cli.converge_geometry &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cli.converge_geometry</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cli/converge_kpoints.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cli.converge_kpoints &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cli.converge_kpoints &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cli.converge_kpoints</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cli/cstdn.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cli.cstdn &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cli.cstdn &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cli.cstdn</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cli/run_nwchem.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cli.run_nwchem &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cli.run_nwchem &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cli.run_nwchem</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cli/run_vasp.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cli.run_vasp &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cli.run_vasp &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cli.run_vasp</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cp2k/handlers.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cp2k.handlers &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cp2k.handlers &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cp2k.handlers</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cp2k/interpreter.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cp2k.interpreter &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cp2k.interpreter &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cp2k.interpreter</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cp2k/jobs.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cp2k.jobs &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cp2k.jobs &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cp2k.jobs</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cp2k/utils.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cp2k.utils &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cp2k.utils &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cp2k.utils</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/cp2k/validators.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.cp2k.validators &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.cp2k.validators &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.cp2k.validators</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/custodian.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.custodian &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.custodian &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/flasky.css" />
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.custodian</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/feff/handlers.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.feff.handlers &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.feff.handlers &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.feff.handlers</a></li>
</ul>
Expand Down
5 changes: 2 additions & 3 deletions docs/_modules/custodian/feff/interpreter.html
View file
@@ -1,11 +1,10 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>custodian.feff.interpreter &#8212; custodian 2023.3.10 documentation</title>
<title>custodian.feff.interpreter &#8212; custodian 2023.5.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/flasky.css" />
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +34,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.3.10 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">custodian 2023.5.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">custodian.feff.interpreter</a></li>
</ul>
Expand Down

0 comments on commit a058337

Please sign in to comment.