Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
knc6 committed Aug 12, 2020
1 parent 601b4aa commit 0b52126
Show file tree
Hide file tree
Showing 118 changed files with 1,731 additions and 623 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.ai.doctree
Binary file not shown.
Binary file added docs/build/doctrees/jarvis.ai.gcn.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.ai.pkgs.sklearn.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.analysis.interface.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.analysis.magnetism.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.analysis.structure.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.core.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/jarvis.io.vasp.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7ca3eb9845cefef0b460d63f6a2822c8
config: 7501274f566aae2e9d1debcabc7b47e8
tags: 645f666f9bcd5a90fca523b33c5a78b7
7 changes: 4 additions & 3 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview: module code &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>Overview: module code &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
</ul>
</div>

Expand Down Expand Up @@ -60,6 +60,7 @@ <h1>All modules for which code is available</h1>
<li><a href="jarvis/analysis/topological/spillage.html">jarvis.analysis.topological.spillage</a></li>
<li><a href="jarvis/core/atoms.html">jarvis.core.atoms</a></li>
<li><a href="jarvis/core/composition.html">jarvis.core.composition</a></li>
<li><a href="jarvis/core/graphs.html">jarvis.core.graphs</a></li>
<li><a href="jarvis/core/kpoints.html">jarvis.core.kpoints</a></li>
<li><a href="jarvis/core/lattice.html">jarvis.core.lattice</a></li>
<li><a href="jarvis/core/pdb_atoms.html">jarvis.core.pdb_atoms</a></li>
Expand Down Expand Up @@ -118,7 +119,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/jarvis/ai/descriptors/cfid.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.descriptors.cfid &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.descriptors.cfid &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -1808,7 +1808,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/jarvis/ai/descriptors/coulomb.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.descriptors.coulomb &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.descriptors.coulomb &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -123,7 +123,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.pkgs.lgbm.classification &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.pkgs.lgbm.classification &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -115,7 +115,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/jarvis/ai/pkgs/lgbm/regression.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.pkgs.lgbm.regression &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.pkgs.lgbm.regression &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -271,7 +271,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.pkgs.sklearn.classification &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.pkgs.sklearn.classification &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -255,7 +255,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.pkgs.sklearn.hyper_params &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.pkgs.sklearn.hyper_params &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -364,7 +364,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.pkgs.sklearn.regression &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.pkgs.sklearn.regression &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -175,7 +175,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/jarvis/ai/pkgs/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.ai.pkgs.utils &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.ai.pkgs.utils &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -198,7 +198,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.analysis.darkmatter.metrics &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.analysis.darkmatter.metrics &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -106,7 +106,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/build/html/_modules/jarvis/analysis/defects/surface.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jarvis.analysis.defects.surface &#8212; JARVIS-Tools 2020.7.14 documentation</title>
<title>jarvis.analysis.defects.surface &#8212; JARVIS-Tools 2020.8.12 documentation</title>
<link rel="stylesheet" href="../../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />

Expand All @@ -28,7 +28,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
</ul>
</div>
Expand Down Expand Up @@ -366,7 +366,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">JARVIS-Tools 2020.7.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">JARVIS-Tools 2020.8.12 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 0b52126

Please sign in to comment.