Update dev docs

materialsproject · May 2, 2022 · 620f722 · 620f722
1 parent a69bc09
commit 620f722
Show file tree

Hide file tree

Showing 45 changed files with 844 additions and 4,267 deletions.
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; pymatgen-db 2022.3.17 documentation</title>
+    <title>Overview: module code &#8212; pymatgen-db 2022.5.2 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>
@@ -37,7 +37,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">pymatgen-db 2022.3.17 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">pymatgen-db 2022.5.2 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
       </ul>
     </div>  
@@ -49,22 +49,10 @@ <h3>Navigation</h3>
 
   <h1>All modules for which code is available</h1>
 <ul><li><a href="pymatgen/db/alchemy/transmuters.html">pymatgen.db.alchemy.transmuters</a></li>
-<li><a href="pymatgen/db/builders/core.html">pymatgen.db.builders.core</a></li>
-<li><a href="pymatgen/db/builders/examples/copy_builder.html">pymatgen.db.builders.examples.copy_builder</a></li>
-<li><a href="pymatgen/db/builders/examples/file_builders.html">pymatgen.db.builders.examples.file_builders</a></li>
-<li><a href="pymatgen/db/builders/examples/maxvalue_builder.html">pymatgen.db.builders.examples.maxvalue_builder</a></li>
-<li><a href="pymatgen/db/builders/incr.html">pymatgen.db.builders.incr</a></li>
-<li><a href="pymatgen/db/builders/schema.html">pymatgen.db.builders.schema</a></li>
-<li><a href="pymatgen/db/builders/util.html">pymatgen.db.builders.util</a></li>
+<li><a href="pymatgen/db/config.html">pymatgen.db.config</a></li>
 <li><a href="pymatgen/db/creator.html">pymatgen.db.creator</a></li>
-<li><a href="pymatgen/db/dbconfig.html">pymatgen.db.dbconfig</a></li>
-<li><a href="pymatgen/db/dbgroup.html">pymatgen.db.dbgroup</a></li>
 <li><a href="pymatgen/db/query_engine.html">pymatgen.db.query_engine</a></li>
 <li><a href="pymatgen/db/util.html">pymatgen.db.util</a></li>
-<li><a href="pymatgen/db/vv/diff.html">pymatgen.db.vv.diff</a></li>
-<li><a href="pymatgen/db/vv/report.html">pymatgen.db.vv.report</a></li>
-<li><a href="pymatgen/db/vv/util.html">pymatgen.db.vv.util</a></li>
-<li><a href="pymatgen/db/vv/validate.html">pymatgen.db.vv.validate</a></li>
 </ul>
 
             <div class="clearer"></div>

diff --git a/docs/_modules/pymatgen/db/alchemy/transmuters.html b/docs/_modules/pymatgen/db/alchemy/transmuters.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>pymatgen.db.alchemy.transmuters &#8212; pymatgen-db 2022.3.17 documentation</title>
+    <title>pymatgen.db.alchemy.transmuters &#8212; pymatgen-db 2022.5.2 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>
@@ -37,7 +37,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">pymatgen-db 2022.3.17 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2022.5.2 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="">pymatgen.db.alchemy.transmuters</a></li> 
       </ul>
@@ -66,6 +66,7 @@ <h1>Source code for pymatgen.db.alchemy.transmuters</h1><div class="highlight"><
 <span class="n">__date__</span> <span class="o">=</span> <span class="s2">&quot;Mar 4, 2012&quot;</span>
 
 <span class="kn">import</span> <span class="nn">datetime</span>
+
 <span class="kn">from</span> <span class="nn">pymatgen.alchemy.materials</span> <span class="kn">import</span> <span class="n">TransformedStructure</span>
 <span class="kn">from</span> <span class="nn">pymatgen.alchemy.transmuters</span> <span class="kn">import</span> <span class="n">StandardTransmuter</span>
 
@@ -97,12 +98,7 @@ <h1>Source code for pymatgen.db.alchemy.transmuters</h1><div class="highlight"><
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">entries</span> <span class="o">=</span> <span class="n">queryengine</span><span class="o">.</span><span class="n">get_entries</span><span class="p">(</span><span class="n">criteria</span><span class="p">,</span> <span class="n">inc_structure</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
-        <span class="n">source</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">:</span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
-            <span class="n">queryengine</span><span class="o">.</span><span class="n">host</span><span class="p">,</span>
-            <span class="n">queryengine</span><span class="o">.</span><span class="n">port</span><span class="p">,</span>
-            <span class="n">queryengine</span><span class="o">.</span><span class="n">database_name</span><span class="p">,</span>
-            <span class="n">queryengine</span><span class="o">.</span><span class="n">collection_name</span><span class="p">,</span>
-        <span class="p">)</span>
+        <span class="n">source</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">queryengine</span><span class="o">.</span><span class="n">host</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">queryengine</span><span class="o">.</span><span class="n">port</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">queryengine</span><span class="o">.</span><span class="n">database_name</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">queryengine</span><span class="o">.</span><span class="n">collection_name</span><span class="si">}</span><span class="s2">&quot;</span>
 
         <span class="k">def</span> <span class="nf">get_history</span><span class="p">(</span><span class="n">entry</span><span class="p">):</span>
             <span class="k">return</span> <span class="p">[</span>