Skip to content

Commit 43a347a

Browse files
committed
Update to v1.0.1
1 parent 0b29cdf commit 43a347a

File tree

72 files changed

+367
-469
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+367
-469
lines changed

atomate/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "1.0.0"
1+
__version__ = "1.0.1"

docs/_sources/atomate.vasp.firetasks.rst.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ Subpackages
1212
Submodules
1313
----------
1414

15+
atomate.vasp.firetasks.approx\_neb\_dynamic\_tasks module
16+
---------------------------------------------------------
17+
18+
.. automodule:: atomate.vasp.firetasks.approx_neb_dynamic_tasks
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
atomate.vasp.firetasks.approx\_neb\_tasks module
24+
------------------------------------------------
25+
26+
.. automodule:: atomate.vasp.firetasks.approx_neb_tasks
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
1531
atomate.vasp.firetasks.electrode\_tasks module
1632
----------------------------------------------
1733

docs/_sources/atomate.vasp.fireworks.rst.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ atomate.vasp.fireworks package
44
Submodules
55
----------
66

7+
atomate.vasp.fireworks.approx\_neb module
8+
-----------------------------------------
9+
10+
.. automodule:: atomate.vasp.fireworks.approx_neb
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
atomate.vasp.fireworks.approx\_neb\_dynamic module
16+
--------------------------------------------------
17+
18+
.. automodule:: atomate.vasp.fireworks.approx_neb_dynamic
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
723
atomate.vasp.fireworks.core module
824
----------------------------------
925

docs/_sources/atomate.vasp.workflows.base.rst.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ atomate.vasp.workflows.base.adsorption module
1212
:undoc-members:
1313
:show-inheritance:
1414

15+
atomate.vasp.workflows.base.approx\_neb module
16+
----------------------------------------------
17+
18+
.. automodule:: atomate.vasp.workflows.base.approx_neb
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
1523
atomate.vasp.workflows.base.bulk\_modulus module
1624
------------------------------------------------
1725

docs/_sources/atomate.vasp.workflows.tests.rst.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ atomate.vasp.workflows.tests.test\_adsorbate\_workflow module
1212
:undoc-members:
1313
:show-inheritance:
1414

15+
atomate.vasp.workflows.tests.test\_approx\_neb\_workflow module
16+
---------------------------------------------------------------
17+
18+
.. automodule:: atomate.vasp.workflows.tests.test_approx_neb_workflow
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
1523
atomate.vasp.workflows.tests.test\_bulk\_modulus\_workflow module
1624
-----------------------------------------------------------------
1725

docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.0.0',
3+
VERSION: '1.0.1',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

docs/advanced_stores.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Advanced Storage Stratagies &#8212; atomate 1.0.0 documentation</title>
8+
<title>Advanced Storage Stratagies &#8212; atomate 1.0.1 documentation</title>
99
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-this"><a href="">Advanced Storage Stratagies</a></li>
3333
</ul>
3434
</div>
@@ -151,7 +151,7 @@ <h3>Navigation</h3>
151151
<li class="right" >
152152
<a href="py-modindex.html" title="Python Module Index"
153153
>modules</a> |</li>
154-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
154+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
155155
<li class="nav-item nav-item-this"><a href="">Advanced Storage Stratagies</a></li>
156156
</ul>
157157
</div>

docs/atomate.common.firetasks.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>atomate.common.firetasks package &#8212; atomate 1.0.0 documentation</title>
8+
<title>atomate.common.firetasks package &#8212; atomate 1.0.1 documentation</title>
99
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-this"><a href="">atomate.common.firetasks package</a></li>
3333
</ul>
3434
</div>
@@ -777,7 +777,7 @@ <h3>Navigation</h3>
777777
<li class="right" >
778778
<a href="py-modindex.html" title="Python Module Index"
779779
>modules</a> |</li>
780-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
780+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
781781
<li class="nav-item nav-item-this"><a href="">atomate.common.firetasks package</a></li>
782782
</ul>
783783
</div>

docs/atomate.common.firetasks.tests.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>atomate.common.firetasks.tests package &#8212; atomate 1.0.0 documentation</title>
8+
<title>atomate.common.firetasks.tests package &#8212; atomate 1.0.1 documentation</title>
99
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-this"><a href="">atomate.common.firetasks.tests package</a></li>
3333
</ul>
3434
</div>
@@ -160,7 +160,7 @@ <h3>Navigation</h3>
160160
<li class="right" >
161161
<a href="py-modindex.html" title="Python Module Index"
162162
>modules</a> |</li>
163-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
163+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
164164
<li class="nav-item nav-item-this"><a href="">atomate.common.firetasks.tests package</a></li>
165165
</ul>
166166
</div>

docs/atomate.common.html

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>atomate.common package &#8212; atomate 1.0.0 documentation</title>
8+
<title>atomate.common package &#8212; atomate 1.0.1 documentation</title>
99
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-this"><a href="">atomate.common package</a></li>
3333
</ul>
3434
</div>
@@ -92,6 +92,23 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
9292
</dl>
9393
</dd></dl>
9494

95+
<dl class="py function">
96+
<dt id="atomate.common.powerups.add_metadata">
97+
<code class="sig-prename descclassname">atomate.common.powerups.</code><code class="sig-name descname">add_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">wf</span></em>, <em class="sig-param"><span class="n">meta_dict</span></em>, <em class="sig-param"><span class="n">fw_name_constraint</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#atomate.common.powerups.add_metadata" title="Permalink to this definition"></a></dt>
98+
<dd><p>Add a metadata dictionary to a Workflow and all its Fireworks. The dictionary
99+
is merged into the “metadata” key of the Workflow and into the “_spec” key of
100+
each Firework in the workflow.</p>
101+
<p>Can be used in combination with add_additional_fields_to_taskdocs to add the
102+
same set of key-value pairs to Workflows, Fireworks and Tasks collections.</p>
103+
<dl class="simple">
104+
<dt>Args:</dt><dd><p>wf (Workflow)
105+
meta_dict: dictionary of custom metadata</p>
106+
</dd>
107+
<dt>Returns:</dt><dd><p>Workflow</p>
108+
</dd>
109+
</dl>
110+
</dd></dl>
111+
95112
<dl class="py function">
96113
<dt id="atomate.common.powerups.add_namefile">
97114
<code class="sig-prename descclassname">atomate.common.powerups.</code><code class="sig-name descname">add_namefile</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">original_wf</span></em>, <em class="sig-param"><span class="n">use_slug</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#atomate.common.powerups.add_namefile" title="Permalink to this definition"></a></dt>
@@ -288,7 +305,7 @@ <h3>Navigation</h3>
288305
<li class="right" >
289306
<a href="py-modindex.html" title="Python Module Index"
290307
>modules</a> |</li>
291-
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.0 documentation</a> &#187;</li>
308+
<li class="nav-item nav-item-0"><a href="index.html">atomate 1.0.1 documentation</a> &#187;</li>
292309
<li class="nav-item nav-item-this"><a href="">atomate.common package</a></li>
293310
</ul>
294311
</div>

0 commit comments

Comments
 (0)