Skip to content

Commit 141ce35

Browse files
author
Shyue Ping Ong
committed
Update dev docs
1 parent 253d1e6 commit 141ce35

File tree

118 files changed

+12584
-1601
lines changed

Some content is hidden

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

118 files changed

+12584
-1601
lines changed

‎docs/_modules/index.html‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
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 2022.1.15 documentation</title>
8+
<title>Overview: module code &#8212; pymatgen-diffusion 2022.7.21 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/flasky.css" />
1111
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
1212
<script src="../_static/jquery.js"></script>
1313
<script src="../_static/underscore.js"></script>
14+
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
1415
<script src="../_static/doctools.js"></script>
1516
<link rel="index" title="Index" href="../genindex.html" />
1617
<link rel="search" title="Search" href="../search.html" />
@@ -36,7 +37,7 @@ <h3>Navigation</h3>
3637
<li class="right" >
3738
<a href="../py-modindex.html" title="Python Module Index"
3839
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../index.html">pymatgen-diffusion 2022.1.15 documentation</a> &#187;</li>
40+
<li class="nav-item nav-item-0"><a href="../index.html">pymatgen-diffusion 2022.7.21 documentation</a> &#187;</li>
4041
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
4142
</ul>
4243
</div>
@@ -47,8 +48,7 @@ <h3>Navigation</h3>
4748
<div class="body" role="main">
4849

4950
<h1>All modules for which code is available</h1>
50-
<ul><li><a href="pymatgen/analysis/diffusion/aimd/clustering.html">pymatgen.analysis.diffusion.aimd.clustering</a></li>
51-
<li><a href="pymatgen/analysis/diffusion/aimd/pathway.html">pymatgen.analysis.diffusion.aimd.pathway</a></li>
51+
<ul><li><a href="pymatgen/analysis/diffusion/aimd/pathway.html">pymatgen.analysis.diffusion.aimd.pathway</a></li>
5252
<li><a href="pymatgen/analysis/diffusion/aimd/rdf.html">pymatgen.analysis.diffusion.aimd.rdf</a></li>
5353
<li><a href="pymatgen/analysis/diffusion/aimd/tests/test_clustering.html">pymatgen.analysis.diffusion.aimd.tests.test_clustering</a></li>
5454
<li><a href="pymatgen/analysis/diffusion/aimd/tests/test_pathway.html">pymatgen.analysis.diffusion.aimd.tests.test_pathway</a></li>
@@ -64,6 +64,7 @@ <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/tests/test_pathfinder.html">pymatgen.analysis.diffusion.tests.test_pathfinder</a></li>
6768
<li><a href="pymatgen/analysis/diffusion/utils/edge_data_from_sc.html">pymatgen.analysis.diffusion.utils.edge_data_from_sc</a></li>
6869
<li><a href="pymatgen/analysis/diffusion/utils/parse_entries.html">pymatgen.analysis.diffusion.utils.parse_entries</a></li>
6970
<li><a href="pymatgen/analysis/diffusion/utils/supercells.html">pymatgen.analysis.diffusion.utils.supercells</a></li>
@@ -90,7 +91,7 @@ <h3 id="searchlabel">Quick search</h3>
9091
</form>
9192
</div>
9293
</div>
93-
<script>$('#searchbox').show(0);</script>
94+
<script>document.getElementById('searchbox').style.display = "block"</script>
9495
</div>
9596
</div>
9697
<div class="clearer"></div>

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
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 2022.1.15 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.pathway &#8212; pymatgen-diffusion 2022.7.21 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../../../../_static/flasky.css" />
1111
<script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script>
1212
<script src="../../../../../_static/jquery.js"></script>
1313
<script src="../../../../../_static/underscore.js"></script>
14+
<script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1415
<script src="../../../../../_static/doctools.js"></script>
1516
<link rel="index" title="Index" href="../../../../../genindex.html" />
1617
<link rel="search" title="Search" href="../../../../../search.html" />
@@ -36,7 +37,7 @@ <h3>Navigation</h3>
3637
<li class="right" >
3738
<a href="../../../../../py-modindex.html" title="Python Module Index"
3839
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2022.1.15 documentation</a> &#187;</li>
40+
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2022.7.21 documentation</a> &#187;</li>
4041
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4142
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.pathway</a></li>
4243
</ul>
@@ -155,7 +156,7 @@ <h1>Source code for pymatgen.analysis.diffusion.aimd.pathway</h1><div class="hig
155156
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">count</span><span class="o">.</span><span class="n">most_common</span><span class="p">(</span><span class="n">ngrid</span><span class="p">):</span>
156157
<span class="n">Pr</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">/</span> <span class="n">nsteps</span> <span class="o">/</span> <span class="nb">len</span><span class="p">(</span><span class="n">indices</span><span class="p">)</span> <span class="o">/</span> <span class="n">lattice</span><span class="o">.</span><span class="n">volume</span> <span class="o">*</span> <span class="n">ngrid</span>
157158

158-
<span class="n">Pr</span> <span class="o">=</span> <span class="n">Pr</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">lens</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">lens</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">lens</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
159+
<span class="n">Pr</span> <span class="o">=</span> <span class="n">Pr</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">lens</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">lens</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">lens</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span> <span class="c1"># pylint: disable=E1121</span>
159160

160161
<span class="bp">self</span><span class="o">.</span><span class="n">structure</span> <span class="o">=</span> <span class="n">structure</span>
161162
<span class="bp">self</span><span class="o">.</span><span class="n">trajectories</span> <span class="o">=</span> <span class="n">trajectories</span>
@@ -421,7 +422,7 @@ <h3 id="searchlabel">Quick search</h3>
421422
</form>
422423
</div>
423424
</div>
424-
<script>$('#searchbox').show(0);</script>
425+
<script>document.getElementById('searchbox').style.display = "block"</script>
425426
</div>
426427
</div>
427428
<div class="clearer"></div>

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
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 2022.1.15 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.rdf &#8212; pymatgen-diffusion 2022.7.21 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../../../../_static/flasky.css" />
1111
<script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script>
1212
<script src="../../../../../_static/jquery.js"></script>
1313
<script src="../../../../../_static/underscore.js"></script>
14+
<script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1415
<script src="../../../../../_static/doctools.js"></script>
1516
<link rel="index" title="Index" href="../../../../../genindex.html" />
1617
<link rel="search" title="Search" href="../../../../../search.html" />
@@ -36,7 +37,7 @@ <h3>Navigation</h3>
3637
<li class="right" >
3738
<a href="../../../../../py-modindex.html" title="Python Module Index"
3839
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2022.1.15 documentation</a> &#187;</li>
40+
<li class="nav-item nav-item-0"><a href="../../../../../index.html">pymatgen-diffusion 2022.7.21 documentation</a> &#187;</li>
4041
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4142
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.rdf</a></li>
4243
</ul>
@@ -557,7 +558,7 @@ <h3 id="searchlabel">Quick search</h3>
557558
</form>
558559
</div>
559560
</div>
560-
<script>$('#searchbox').show(0);</script>
561+
<script>document.getElementById('searchbox').style.display = "block"</script>
561562
</div>
562563
</div>
563564
<div class="clearer"></div>

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
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 2022.1.15 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_clustering &#8212; pymatgen-diffusion 2022.7.21 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../../../../../_static/flasky.css" />
1111
<script data-url_root="../../../../../../" id="documentation_options" src="../../../../../../_static/documentation_options.js"></script>
1212
<script src="../../../../../../_static/jquery.js"></script>
1313
<script src="../../../../../../_static/underscore.js"></script>
14+
<script src="../../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1415
<script src="../../../../../../_static/doctools.js"></script>
1516
<link rel="index" title="Index" href="../../../../../../genindex.html" />
1617
<link rel="search" title="Search" href="../../../../../../search.html" />
@@ -36,7 +37,7 @@ <h3>Navigation</h3>
3637
<li class="right" >
3738
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3839
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2022.1.15 documentation</a> &#187;</li>
40+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2022.7.21 documentation</a> &#187;</li>
4041
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4142
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_clustering</a></li>
4243
</ul>
@@ -133,7 +134,7 @@ <h3 id="searchlabel">Quick search</h3>
133134
</form>
134135
</div>
135136
</div>
136-
<script>$('#searchbox').show(0);</script>
137+
<script>document.getElementById('searchbox').style.display = "block"</script>
137138
</div>
138139
</div>
139140
<div class="clearer"></div>

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
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 2022.1.15 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_pathway &#8212; pymatgen-diffusion 2022.7.21 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../../../../../_static/flasky.css" />
1111
<script data-url_root="../../../../../../" id="documentation_options" src="../../../../../../_static/documentation_options.js"></script>
1212
<script src="../../../../../../_static/jquery.js"></script>
1313
<script src="../../../../../../_static/underscore.js"></script>
14+
<script src="../../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1415
<script src="../../../../../../_static/doctools.js"></script>
1516
<link rel="index" title="Index" href="../../../../../../genindex.html" />
1617
<link rel="search" title="Search" href="../../../../../../search.html" />
@@ -36,7 +37,7 @@ <h3>Navigation</h3>
3637
<li class="right" >
3738
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3839
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2022.1.15 documentation</a> &#187;</li>
40+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2022.7.21 documentation</a> &#187;</li>
4041
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4142
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_pathway</a></li>
4243
</ul>
@@ -191,7 +192,7 @@ <h3 id="searchlabel">Quick search</h3>
191192
</form>
192193
</div>
193194
</div>
194-
<script>$('#searchbox').show(0);</script>
195+
<script>document.getElementById('searchbox').style.display = "block"</script>
195196
</div>
196197
</div>
197198
<div class="clearer"></div>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22
<!DOCTYPE html>
33

4-
<html>
4+
<html lang="en">
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 2022.1.15 documentation</title>
8+
<title>pymatgen.analysis.diffusion.aimd.tests.test_rdf &#8212; pymatgen-diffusion 2022.7.21 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../../../../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../../../../../_static/flasky.css" />
1111
<script data-url_root="../../../../../../" id="documentation_options" src="../../../../../../_static/documentation_options.js"></script>
1212
<script src="../../../../../../_static/jquery.js"></script>
1313
<script src="../../../../../../_static/underscore.js"></script>
14+
<script src="../../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1415
<script src="../../../../../../_static/doctools.js"></script>
1516
<link rel="index" title="Index" href="../../../../../../genindex.html" />
1617
<link rel="search" title="Search" href="../../../../../../search.html" />
@@ -36,7 +37,7 @@ <h3>Navigation</h3>
3637
<li class="right" >
3738
<a href="../../../../../../py-modindex.html" title="Python Module Index"
3839
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2022.1.15 documentation</a> &#187;</li>
40+
<li class="nav-item nav-item-0"><a href="../../../../../../index.html">pymatgen-diffusion 2022.7.21 documentation</a> &#187;</li>
4041
<li class="nav-item nav-item-1"><a href="../../../../../index.html" accesskey="U">Module code</a> &#187;</li>
4142
<li class="nav-item nav-item-this"><a href="">pymatgen.analysis.diffusion.aimd.tests.test_rdf</a></li>
4243
</ul>
@@ -70,7 +71,6 @@ <h1>Source code for pymatgen.analysis.diffusion.aimd.tests.test_rdf</h1><div cla
7071
<span class="n">structure_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
7172
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">9</span><span class="p">:</span>
7273
<span class="k">break</span>
73-
<span class="n">species</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;Na&quot;</span><span class="p">,</span> <span class="s2">&quot;P&quot;</span><span class="p">,</span> <span class="s2">&quot;S&quot;</span><span class="p">]</span>
7474

7575
<span class="c1"># Test from_species</span>
7676
<span class="n">obj</span> <span class="o">=</span> <span class="n">RadialDistributionFunctionFast</span><span class="p">(</span><span class="n">structures</span><span class="o">=</span><span class="n">structure_list</span><span class="p">,</span> <span class="n">ngrid</span><span class="o">=</span><span class="mi">101</span><span class="p">,</span> <span class="n">rmax</span><span class="o">=</span><span class="mf">10.0</span><span class="p">,</span> <span class="n">sigma</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span>
@@ -115,7 +115,7 @@ <h3 id="searchlabel">Quick search</h3>
115115
</form>
116116
</div>
117117
</div>
118-
<script>$('#searchbox').show(0);</script>
118+
<script>document.getElementById('searchbox').style.display = "block"</script>
119119
</div>
120120
</div>
121121
<div class="clearer"></div>

0 commit comments

Comments
 (0)