Skip to content

Commit 7fb82d2

Browse files
shyuepshyuep
committed
Update dev docs
1 parent c9af4b0 commit 7fb82d2

File tree

87 files changed

+1260
-258
lines changed

Some content is hidden

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

87 files changed

+1260
-258
lines changed

‎docs/_modules/index.html‎

Lines changed: 4 additions & 2 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>Overview: module code &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>Overview: module code &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
4141
</ul>
4242
</div>
@@ -64,8 +64,10 @@ <h1>All modules for which code is available</h1>
6464
<li><a href="pymatgen/analysis/diffusion/neb/tests/test_io.html">pymatgen.analysis.diffusion.neb.tests.test_io</a></li>
6565
<li><a href="pymatgen/analysis/diffusion/neb/tests/test_pathfinder.html">pymatgen.analysis.diffusion.neb.tests.test_pathfinder</a></li>
6666
<li><a href="pymatgen/analysis/diffusion/tests/test_analyzer.html">pymatgen.analysis.diffusion.tests.test_analyzer</a></li>
67+
<li><a href="pymatgen/analysis/diffusion/utils/edge_data_from_sc.html">pymatgen.analysis.diffusion.utils.edge_data_from_sc</a></li>
6768
<li><a href="pymatgen/analysis/diffusion/utils/parse_entries.html">pymatgen.analysis.diffusion.utils.parse_entries</a></li>
6869
<li><a href="pymatgen/analysis/diffusion/utils/supercells.html">pymatgen.analysis.diffusion.utils.supercells</a></li>
70+
<li><a href="pymatgen/analysis/diffusion/utils/tests/test_edge_data_from_sc.html">pymatgen.analysis.diffusion.utils.tests.test_edge_data_from_sc</a></li>
6971
<li><a href="pymatgen/analysis/diffusion/utils/tests/test_parse_entries.html">pymatgen.analysis.diffusion.utils.tests.test_parse_entries</a></li>
7072
</ul>
7173

‎docs/_modules/pymatgen/analysis/diffusion/aimd/clustering.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.clustering &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.clustering &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.clustering</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/pathway.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.pathway &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.pathway &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.pathway</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/rdf.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.rdf &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.rdf &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.rdf</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/tests/test_clustering.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.tests.test_clustering &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_clustering &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../../" src="../../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_clustering</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/tests/test_pathway.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.tests.test_pathway &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_pathway &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../../" src="../../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_pathway</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/tests/test_rdf.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.tests.test_rdf &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_rdf &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../../" src="../../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_rdf</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/tests/test_van_hove.html‎

Lines changed: 2 additions & 2 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>pymatgen.analysis.diffusion.aimd.tests.test_van_hove &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_van_hove &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../../" src="../../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_van_hove</a></li>
4242
</ul>

‎docs/_modules/pymatgen/analysis/diffusion/aimd/van_hove.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>pymatgen.analysis.diffusion.aimd.van_hove &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.van_hove &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.van_hove</a></li>
4242
</ul>
@@ -107,7 +107,7 @@ <h1>Source code for pymatgen.analysis.diffusion.aimd.van_hove</h1><div class="hi
107107

108108
<span class="sd"> Args:</span>
109109
<span class="sd"> diffusion_analyzer (DiffusionAnalyzer): A</span>
110-
<span class="sd"> pymatgen.analysis.diffusion_analyzer.DiffusionAnalyzer object</span>
110+
<span class="sd"> pymatgen.analysis.diffusion.analyzer.DiffusionAnalyzer object</span>
111111
<span class="sd"> avg_nsteps (int): Number of t0 used for statistical average</span>
112112
<span class="sd"> ngrid (int): Number of radial grid points</span>
113113
<span class="sd"> rmax (float): Maximum of radial grid (the minimum is always set zero)</span>

‎docs/_modules/pymatgen/analysis/diffusion/analyzer.html‎

Lines changed: 8 additions & 10 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>pymatgen.analysis.diffusion.analyzer &#8212; pymatgen-diffusion 2021.3.6 documentation</title>
8+
<title>pymatgen.analysis.diffusion.analyzer &#8212; pymatgen-diffusion 2021.4.29 documentation</title>
99
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../../_static/flasky.css" type="text/css" />
1111
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="../../../../py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-diffusion 2021.3.6 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-diffusion 2021.4.29 documentation</a> &#187;</li>
4040
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
4141
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.analyzer</a></li>
4242
</ul>
@@ -766,14 +766,12 @@ <h1>Source code for pymatgen.analysis.diffusion.analyzer</h1><div class="highlig
766766
<span class="sd"> Examples include smoothed, min_obs, avg_nsteps.</span>
767767
<span class="sd"> &quot;&quot;&quot;</span>
768768
<span class="k">if</span> <span class="n">ncores</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">filepaths</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
769-
<span class="n">p</span> <span class="o">=</span> <span class="n">multiprocessing</span><span class="o">.</span><span class="n">Pool</span><span class="p">(</span><span class="n">ncores</span><span class="p">)</span>
770-
<span class="n">vaspruns</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">imap</span><span class="p">(</span><span class="n">_get_vasprun</span><span class="p">,</span> <span class="p">[(</span><span class="n">fp</span><span class="p">,</span> <span class="n">step_skip</span><span class="p">)</span> <span class="k">for</span> <span class="n">fp</span> <span class="ow">in</span> <span class="n">filepaths</span><span class="p">])</span>
771-
<span class="n">analyzer</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">from_vaspruns</span><span class="p">(</span>
772-
<span class="n">vaspruns</span><span class="p">,</span> <span class="n">specie</span><span class="o">=</span><span class="n">specie</span><span class="p">,</span> <span class="n">initial_disp</span><span class="o">=</span><span class="n">initial_disp</span><span class="p">,</span> <span class="n">initial_structure</span><span class="o">=</span><span class="n">initial_structure</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
773-
<span class="p">)</span>
774-
<span class="n">p</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
775-
<span class="n">p</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
776-
<span class="k">return</span> <span class="n">analyzer</span>
769+
<span class="k">with</span> <span class="n">multiprocessing</span><span class="o">.</span><span class="n">Pool</span><span class="p">(</span><span class="n">ncores</span><span class="p">)</span> <span class="k">as</span> <span class="n">p</span><span class="p">:</span>
770+
<span class="n">vaspruns</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">imap</span><span class="p">(</span><span class="n">_get_vasprun</span><span class="p">,</span> <span class="p">[(</span><span class="n">fp</span><span class="p">,</span> <span class="n">step_skip</span><span class="p">)</span> <span class="k">for</span> <span class="n">fp</span> <span class="ow">in</span> <span class="n">filepaths</span><span class="p">])</span>
771+
<span class="n">analyzer</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">from_vaspruns</span><span class="p">(</span>
772+
<span class="n">vaspruns</span><span class="p">,</span> <span class="n">specie</span><span class="o">=</span><span class="n">specie</span><span class="p">,</span> <span class="n">initial_disp</span><span class="o">=</span><span class="n">initial_disp</span><span class="p">,</span> <span class="n">initial_structure</span><span class="o">=</span><span class="n">initial_structure</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
773+
<span class="p">)</span>
774+
<span class="k">return</span> <span class="n">analyzer</span>
777775

778776
<span class="k">def</span> <span class="nf">vr</span><span class="p">(</span><span class="n">filepaths</span><span class="p">):</span>
779777
<span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span>

0 commit comments

Comments
 (0)