You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -92,6 +92,23 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
92
92
</dl>
93
93
</dd></dl>
94
94
95
+
<dlclass="py function">
96
+
<dtid="atomate.common.powerups.add_metadata">
97
+
<codeclass="sig-prename descclassname">atomate.common.powerups.</code><codeclass="sig-name descname">add_metadata</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">wf</span></em>, <emclass="sig-param"><spanclass="n">meta_dict</span></em>, <emclass="sig-param"><spanclass="n">fw_name_constraint</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="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
+
<dlclass="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
+
95
112
<dlclass="py function">
96
113
<dtid="atomate.common.powerups.add_namefile">
97
114
<codeclass="sig-prename descclassname">atomate.common.powerups.</code><codeclass="sig-name descname">add_namefile</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">original_wf</span></em>, <emclass="sig-param"><spanclass="n">use_slug</span><spanclass="o">=</span><spanclass="default_value">True</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#atomate.common.powerups.add_namefile" title="Permalink to this definition">¶</a></dt>
0 commit comments