Update docs

materialsproject · Apr 26, 2022 · 1b6d1d2 · 1b6d1d2
1 parent cae0b16
commit 1b6d1d2
Show file tree

Hide file tree

Showing 303 changed files with 6,403 additions and 6,328 deletions.
diff --git 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: '2022.4.19',
+    VERSION: '2022.4.26',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/addons.html b/docs/addons.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Pymatgen Add-ons &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Pymatgen Add-ons &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -37,7 +37,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/change_log.html b/docs/change_log.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Change log &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Change log &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -53,6 +53,7 @@
 <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Change log</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#v2022-4-26">v2022.4.26</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v2022-4-19">v2022.4.19</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v2022-3-29">v2022.3.29</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v2022-3-24">v2022.3.24</a></li>
@@ -391,6 +392,15 @@
 
   <section id="change-log">
 <h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
+<section id="v2022-4-26">
+<h2>v2022.4.26<a class="headerlink" href="#v2022-4-26" title="Permalink to this headline"></a></h2>
+<ul class="simple">
+<li><p>Fix dipole units in recent vasp versions (at least 6.3, maybe even before) (&#64;&#64;fraricci)</p></li>
+<li><p>Removed complex numbers from the definition of WSWQ (&#64;jmmshn)</p></li>
+<li><p>MP database version logging is now no longer logged in the .pmgrc.yaml but rather in the .mprester.log.yaml.
+This avoids the MPRester constantly rewriting a config file and causing users’ pymatgen to completely fail.</p></li>
+</ul>
+</section>
 <section id="v2022-4-19">
 <h2>v2022.4.19<a class="headerlink" href="#v2022-4-19" title="Permalink to this headline"></a></h2>
 <ul class="simple">

diff --git a/docs/compatibility.html b/docs/compatibility.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Compatibility &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Compatibility &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/contributing.html b/docs/contributing.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Contributing &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Index &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -36,7 +36,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -2319,8 +2319,6 @@ <h2 id="D">D</h2>
         <li><a href="pymatgen.io.wannier90.html#id0">(Unk property)</a>
 </li>
         <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.Wavederf.data">(Wavederf attribute)</a>
-</li>
-        <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.data">(WSWQ attribute)</a>
 </li>
       </ul></li>
       <li><a href="pymatgen.io.abinit.variable.html#pymatgen.io.abinit.variable.InputVariable.dataset">dataset (InputVariable property)</a>
@@ -8042,6 +8040,10 @@ <h2 id="M">M</h2>
       <li><a href="pymatgen.io.lammps.inputs.html#pymatgen.io.lammps.inputs.LammpsRun.md">md() (LammpsRun class method)</a>
 </li>
       <li><a href="pymatgen.io.abinit.pseudos.html#pymatgen.io.abinit.pseudos.Pseudo.md5">md5() (Pseudo method)</a>
+</li>
+      <li><a href="pymatgen.io.vasp.outputs.html#id0">me_imag (WSWQ attribute)</a>, <a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.me_imag">[1]</a>
+</li>
+      <li><a href="pymatgen.io.vasp.outputs.html#id1">me_real (WSWQ attribute)</a>, <a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.me_real">[1]</a>
 </li>
       <li><a href="pymatgen.analysis.chemenv.utils.func_utils.html#pymatgen.analysis.chemenv.utils.func_utils.CSMFiniteRatioFunction.mean_estimator">mean_estimator() (CSMFiniteRatioFunction method)</a>
 
@@ -9137,7 +9139,7 @@ <h2 id="N">N</h2>
       <ul>
         <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.Waveder.nbands">(Waveder property)</a>
 </li>
-        <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.nbands">(WSWQ attribute)</a>
+        <li><a href="pymatgen.io.vasp.outputs.html#id2">(WSWQ attribute)</a>, <a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.nbands">[1]</a>
 </li>
       </ul></li>
       <li><a href="pymatgen.io.wannier90.html#id3">nbnd (Unk attribute)</a>, <a href="pymatgen.io.wannier90.html#pymatgen.io.wannier90.Unk.nbnd">[1]</a>
@@ -9251,7 +9253,7 @@ <h2 id="N">N</h2>
       <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.Waveder.nkpoints">nkpoints (Waveder property)</a>
 
       <ul>
-        <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.nkpoints">(WSWQ attribute)</a>
+        <li><a href="pymatgen.io.vasp.outputs.html#id3">(WSWQ attribute)</a>, <a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.nkpoints">[1]</a>
 </li>
       </ul></li>
   </ul></td>
@@ -9364,7 +9366,7 @@ <h2 id="N">N</h2>
 </li>
       <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.Dynmat.nspecs">nspecs (Dynmat property)</a>
 </li>
-      <li><a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.nspin">nspin (WSWQ attribute)</a>
+      <li><a href="pymatgen.io.vasp.outputs.html#id4">nspin (WSWQ attribute)</a>, <a href="pymatgen.io.vasp.outputs.html#pymatgen.io.vasp.outputs.WSWQ.nspin">[1]</a>
 </li>
       <li><a href="pymatgen.io.abinit.abiobjects.html#pymatgen.io.abinit.abiobjects.Electrons.nspinor">nspinor (Electrons property)</a>
 </li>

diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Introduction &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Introduction &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -38,7 +38,7 @@
             <a href="#" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -207,14 +207,13 @@ <h2>Why use pymatgen?<a class="headerlink" href="#why-use-pymatgen" title="Perma
 </section>
 <section id="change-log">
 <h2>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h2>
-<section id="v2022-4-19">
-<h3>v2022.4.19<a class="headerlink" href="#v2022-4-19" title="Permalink to this headline"></a></h3>
+<section id="v2022-4-26">
+<h3>v2022.4.26<a class="headerlink" href="#v2022-4-26" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p>Fix for discharged and charged entries in conversion battery. (&#64;peikai)`pylint` in <cite>.pre-commit-config.yaml</cite>.</p></li>
-<li><p>Allow skipping of structure reduction in StructureMatcher.group_structures (&#64;lan496)</p></li>
-<li><p>Return NotImplemented for composition comparison methods. (&#64;janosh)</p></li>
-<li><p>BSPlotter bug fixes (&#64;fraricci)</p></li>
-<li><p>Misc bug fixes and deprecation fixes.</p></li>
+<li><p>Fix dipole units in recent vasp versions (at least 6.3, maybe even before) (&#64;&#64;fraricci)</p></li>
+<li><p>Removed complex numbers from the definition of WSWQ (&#64;jmmshn)</p></li>
+<li><p>MP database version logging is now no longer logged in the .pmgrc.yaml but rather in the .mprester.log.yaml.
+This avoids the MPRester constantly rewriting a config file and causing users’ pymatgen to completely fail.</p></li>
 </ul>
 <p><a class="reference internal" href="change_log.html"><span class="doc">Older versions</span></a></p>
 </section>

diff --git a/docs/installation.html b/docs/installation.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Installation &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/introduction.html b/docs/introduction.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Introduction &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Introduction &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -55,7 +55,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#matgenie-examples">Matgenie &amp; Examples</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#why-use-pymatgen">Why use pymatgen?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#change-log">Change log</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#v2022-4-19">v2022.4.19</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#v2022-4-26">v2022.4.26</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#getting-pymatgen">Getting pymatgen</a></li>
@@ -227,14 +227,13 @@ <h2>Why use pymatgen?<a class="headerlink" href="#why-use-pymatgen" title="Perma
 </section>
 <section id="change-log">
 <h2>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h2>
-<section id="v2022-4-19">
-<h3>v2022.4.19<a class="headerlink" href="#v2022-4-19" title="Permalink to this headline"></a></h3>
+<section id="v2022-4-26">
+<h3>v2022.4.26<a class="headerlink" href="#v2022-4-26" title="Permalink to this headline"></a></h3>
 <ul class="simple">
-<li><p>Fix for discharged and charged entries in conversion battery. (&#64;peikai)`pylint` in <cite>.pre-commit-config.yaml</cite>.</p></li>
-<li><p>Allow skipping of structure reduction in StructureMatcher.group_structures (&#64;lan496)</p></li>
-<li><p>Return NotImplemented for composition comparison methods. (&#64;janosh)</p></li>
-<li><p>BSPlotter bug fixes (&#64;fraricci)</p></li>
-<li><p>Misc bug fixes and deprecation fixes.</p></li>
+<li><p>Fix dipole units in recent vasp versions (at least 6.3, maybe even before) (&#64;&#64;fraricci)</p></li>
+<li><p>Removed complex numbers from the definition of WSWQ (&#64;jmmshn)</p></li>
+<li><p>MP database version logging is now no longer logged in the .pmgrc.yaml but rather in the .mprester.log.yaml.
+This avoids the MPRester constantly rewriting a config file and causing users’ pymatgen to completely fail.</p></li>
 </ul>
 <p><a class="reference internal" href="change_log.html"><span class="doc">Older versions</span></a></p>
 </section>

diff --git a/docs/latest_changes.html b/docs/latest_changes.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Change log &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Change log &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -37,7 +37,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -85,14 +85,13 @@
 
   <section id="change-log">
 <h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
-<section id="v2022-4-19">
-<h2>v2022.4.19<a class="headerlink" href="#v2022-4-19" title="Permalink to this headline"></a></h2>
+<section id="v2022-4-26">
+<h2>v2022.4.26<a class="headerlink" href="#v2022-4-26" title="Permalink to this headline"></a></h2>
 <ul class="simple">
-<li><p>Fix for discharged and charged entries in conversion battery. (&#64;peikai)`pylint` in <cite>.pre-commit-config.yaml</cite>.</p></li>
-<li><p>Allow skipping of structure reduction in StructureMatcher.group_structures (&#64;lan496)</p></li>
-<li><p>Return NotImplemented for composition comparison methods. (&#64;janosh)</p></li>
-<li><p>BSPlotter bug fixes (&#64;fraricci)</p></li>
-<li><p>Misc bug fixes and deprecation fixes.</p></li>
+<li><p>Fix dipole units in recent vasp versions (at least 6.3, maybe even before) (&#64;&#64;fraricci)</p></li>
+<li><p>Removed complex numbers from the definition of WSWQ (&#64;jmmshn)</p></li>
+<li><p>MP database version logging is now no longer logged in the .pmgrc.yaml but rather in the .mprester.log.yaml.
+This avoids the MPRester constantly rewriting a config file and causing users’ pymatgen to completely fail.</p></li>
 </ul>
 </section>
 </section>

diff --git a/docs/modules.html b/docs/modules.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pymatgen &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>pymatgen &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; pymatgen 2022.4.19 documentation</title>
+  <title>Python Module Index &mdash; pymatgen 2022.4.26 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
@@ -39,7 +39,7 @@
             <a href="index.html" class="icon icon-home"> pymatgen
           </a>
               <div class="version">
-                2022.4.19
+                2022.4.26
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">