Skip to content
Snippets Groups Projects
Commit 0e62a94d authored by Aakash Ashok Naik's avatar Aakash Ashok Naik :eyes:
Browse files

Updated documentation

parent c76dfcd8
No related branches found
No related tags found
No related merge requests found
Showing
with 540 additions and 58 deletions
# atomic-features-package # Description
Unified package that contains atomic-features from various sources like PYMATGEN,MAGPIE,LDA2015 amd FHI_dft can be imported into Jupyter-notebook for performing various machine learning studies Unified package that contains atomic-features from various sources like PYMATGEN,MAGPIE,LDA2015 amd FHI_dft can be imported into Jupyter-notebook for performing various machine learning studies
......
# Description
Unified package that contains atomic-features from various sources like PYMATGEN,MAGPIE,LDA2015 amd FHI_dft can be imported into Jupyter-notebook for performing various machine learning studies
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
# Getting Started
To install this package download it as tar.gz archive. Then use the following command
```pip install ./<name-of-tar-package>.tar.gz```
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
# Importing this package modules in Jupyter notebook
```from atomicfeaturespackage.atomicproperties import periodictable```
This module is a visualization tool that allows us to visualize atomic properites of all elements accross periodic table as a heatmap. Currently, this tool is able to visualize atomic properties acessible from atomic_properties_dft and atomic_properties_lda2015 module.
Below is an example line of code you need to run to visualize data calculated via the HSE06 functional and spinless settings.
```periodictable.heatmap(Spin = 'False', method = 'hse06')```
In method arg in heatmap function one can specify what functional one wants visualize atomic properties for.
Currently data evaluated are available from following functionals 'HSE06', 'REVPBE', 'PW-LDA', 'PBE' , 'PBESOL', 'PBE0', 'LDA2015' .<br/>
Spin Setting can be set to 'TRUE' or 'FALSE'.
After running the above line of code one gets a plot of complete periodic table of elements. From the dropdown menu, one can select which property one is interested to check and the table is updated automatically to show the corresponding heatmap.
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
```from atomicfeaturespackage.atomicproperties import atomic_properties_dft as dft```
This module contains several atomic features accessible from FHI-AIMS dft calculations
To access atomic properties calculated from different DFT functionals and spin setting one first need to instantiate Specific functional and spin setting one is interested to access using the method function of this module. This can be done as follows :
```dft.method(method = 'pbe', Spin = 'False')```
Currently data evaluated are available from following functionals 'HSE06', 'REVPBE', 'PW-LDA', 'PBE' , 'PBESOL', 'PBE0'.
Spin Setting can be set to 'TRUE' or 'FALSE'.
One can now acess individually different properties using element symbol as following
```
dft.C.atomic_ea
dft.C.atomic_r_p
dft.C.atomic_ip_by_half_charged_homo
```
To get a list of properties accessible one can just press Tab after typing in `dft.C.`
Use symbol method from atomic_properties_dft module to acess property of interest of elements at once say for example we have a python list ls = ['Sc','Ti', 'V', 'Cr'] and we wish to get atomic number of these elements we can do the following
```
atomic_number = []
for i in ls:
atomic_number.append(dft.symbol(i).atomic_number)
```
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
```from atomicfeaturespackage.atomicproperties import atomic_properties_pymat as pymat```
This module contains several atomic features accessible from pymatgen
One can now acess individually different properties using element symbol as following
```
pymat.C.atomic_ea
pymat.C.atomic_r_p
pymat.C.atomic_ip_by_half_charged_homo
```
To get a list of properties accessible one can just press Tab after typing in `pymat.C.`
Use symbol method from atomic_properties_pymat module to acess property of interest of elements at once in similar manner as described for atomic_properties_dft module above.
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
```from atomicfeaturespackage.atomicproperties import atomic_properties_lda2015 as lda```
This module contains several atomic features accessible from lda2015 paper
One can acess individually different properties using element symbol as following
```
lda.C.atomic_ea
lda.C.atomic_r_p
```
To get a list of properties accessible one can just press Tab after typing in `lda.C.`
Use symbol method from atomic_properties_lda2015 module to acess property of interest of elements at once in similar manner as described for atomic_properties_dft module above.
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
File added
No preview for this file type
No preview for this file type
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e8225212ff0a17c24d825f5a3ec2076c config: 32e76b9137648912bbb6319360013c6d
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Description &mdash; atomic-features-package documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="atomicfeaturespackage package" href="atomicfeaturespackage.html" />
<link rel="prev" title="Welcome to atomic-features-package’s documentation!" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> atomic-features-package
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">atomic-features-package</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Description</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="description">
<h1>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h1>
<p>Unified package that contains atomic-features from various sources like PYMATGEN,MAGPIE,LDA2015 amd FHI_dft can be imported into Jupyter-notebook for performing various machine learning studies</p>
<p><strong>——————————————————————————————————————————————————-</strong></p>
</div>
<div class="section" id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
<p>To install this package download it as tar.gz archive. Then use the following command</p>
<p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">./&lt;name-of-tar-package&gt;.tar.gz</span></code></p>
<p><strong>——————————————————————————————————————————————————-</strong></p>
</div>
<div class="section" id="importing-this-package-modules-in-jupyter-notebook">
<h1>Importing this package modules in Jupyter notebook<a class="headerlink" href="#importing-this-package-modules-in-jupyter-notebook" title="Permalink to this headline"></a></h1>
<p><code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">atomicfeaturespackage.atomicproperties</span> <span class="pre">import</span> <span class="pre">periodictable</span></code></p>
<p>This module is a visualization tool that allows us to visualize atomic properites of all elements accross periodic table as a heatmap. Currently, this tool is able to visualize atomic properties acessible from atomic_properties_dft and atomic_properties_lda2015 module.</p>
<p>Below is an example line of code you need to run to visualize data calculated via the HSE06 functional and spinless settings.</p>
<p><code class="docutils literal notranslate"><span class="pre">periodictable.heatmap(Spin</span> <span class="pre">=</span> <span class="pre">'False',</span> <span class="pre">method</span> <span class="pre">=</span> <span class="pre">'hse06')</span></code></p>
<p>In method arg in heatmap function one can specify what functional one wants visualize atomic properties for.
Currently data evaluated are available from following functionals ‘HSE06’, ‘REVPBE’, ‘PW-LDA’, ‘PBE’ , ‘PBESOL’, ‘PBE0’, ‘LDA2015’ .<br/>
Spin Setting can be set to ‘TRUE’ or ‘FALSE’.</p>
<p>After running the above line of code one gets a plot of complete periodic table of elements. From the dropdown menu, one can select which property one is interested to check and the table is updated automatically to show the corresponding heatmap.</p>
<p><strong>——————————————————————————————————————————————————-</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">atomicfeaturespackage.atomicproperties</span> <span class="pre">import</span> <span class="pre">atomic_properties_dft</span> <span class="pre">as</span> <span class="pre">dft</span></code></p>
<p>This module contains several atomic features accessible from FHI-AIMS dft calculations</p>
<p>To access atomic properties calculated from different DFT functionals and spin setting one first need to instantiate Specific functional and spin setting one is interested to access using the method function of this module. This can be done as follows :</p>
<p><code class="docutils literal notranslate"><span class="pre">dft.method(method</span> <span class="pre">=</span> <span class="pre">'pbe',</span> <span class="pre">Spin</span> <span class="pre">=</span> <span class="pre">'False')</span></code></p>
<p>Currently data evaluated are available from following functionals ‘HSE06’, ‘REVPBE’, ‘PW-LDA’, ‘PBE’ , ‘PBESOL’, ‘PBE0’.</p>
<p>Spin Setting can be set to ‘TRUE’ or ‘FALSE’.</p>
<p>One can now acess individually different properties using element symbol as following</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">dft</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_ea</span>
<span class="n">dft</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_r_p</span>
<span class="n">dft</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_ip_by_half_charged_homo</span>
</pre></div>
</div>
<p>To get a list of properties accessible one can just press Tab after typing in <code class="docutils literal notranslate"><span class="pre">dft.C.</span></code></p>
<p>Use symbol method from atomic_properties_dft module to acess property of interest of elements at once say for example we have a python list ls = [‘Sc’,’Ti’, ‘V’, ‘Cr’] and we wish to get atomic number of these elements we can do the following</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">atomic_number</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">ls</span><span class="p">:</span>
<span class="n">atomic_number</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dft</span><span class="o">.</span><span class="n">symbol</span><span class="p">(</span><span class="n">i</span><span class="p">)</span><span class="o">.</span><span class="n">atomic_number</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>——————————————————————————————————————————————————-</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">atomicfeaturespackage.atomicproperties</span> <span class="pre">import</span> <span class="pre">atomic_properties_pymat</span> <span class="pre">as</span> <span class="pre">pymat</span></code></p>
<p>This module contains several atomic features accessible from pymatgen</p>
<p>One can now acess individually different properties using element symbol as following</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">pymat</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_ea</span>
<span class="n">pymat</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_r_p</span>
<span class="n">pymat</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_ip_by_half_charged_homo</span>
</pre></div>
</div>
<p>To get a list of properties accessible one can just press Tab after typing in <code class="docutils literal notranslate"><span class="pre">pymat.C.</span></code></p>
<p>Use symbol method from atomic_properties_pymat module to acess property of interest of elements at once in similar manner as described for atomic_properties_dft module above.</p>
<p><strong>——————————————————————————————————————————————————-</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">atomicfeaturespackage.atomicproperties</span> <span class="pre">import</span> <span class="pre">atomic_properties_lda2015</span> <span class="pre">as</span> <span class="pre">lda</span></code></p>
<p>This module contains several atomic features accessible from lda2015 paper</p>
<p>One can acess individually different properties using element symbol as following</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">lda</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_ea</span>
<span class="n">lda</span><span class="o">.</span><span class="n">C</span><span class="o">.</span><span class="n">atomic_r_p</span>
</pre></div>
</div>
<p>To get a list of properties accessible one can just press Tab after typing in <code class="docutils literal notranslate"><span class="pre">lda.C.</span></code></p>
<p>Use symbol method from atomic_properties_lda2015 module to acess property of interest of elements at once in similar manner as described for atomic_properties_dft module above.</p>
<p><strong>——————————————————————————————————————————————————-</strong></p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="atomicfeaturespackage.html" class="btn btn-neutral float-right" title="atomicfeaturespackage package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to atomic-features-package’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Aakash Naik
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
# Description
Unified package that contains atomic-features from various sources like PYMATGEN,MAGPIE,LDA2015 amd FHI_dft can be imported into Jupyter-notebook for performing various machine learning studies
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
# Getting Started
To install this package download it as tar.gz archive. Then use the following command
```pip install ./<name-of-tar-package>.tar.gz```
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
# Importing this package modules in Jupyter notebook
```from atomicfeaturespackage.atomicproperties import periodictable```
This module is a visualization tool that allows us to visualize atomic properites of all elements accross periodic table as a heatmap. Currently, this tool is able to visualize atomic properties acessible from atomic_properties_dft and atomic_properties_lda2015 module.
Below is an example line of code you need to run to visualize data calculated via the HSE06 functional and spinless settings.
```periodictable.heatmap(Spin = 'False', method = 'hse06')```
In method arg in heatmap function one can specify what functional one wants visualize atomic properties for.
Currently data evaluated are available from following functionals 'HSE06', 'REVPBE', 'PW-LDA', 'PBE' , 'PBESOL', 'PBE0', 'LDA2015' .<br/>
Spin Setting can be set to 'TRUE' or 'FALSE'.
After running the above line of code one gets a plot of complete periodic table of elements. From the dropdown menu, one can select which property one is interested to check and the table is updated automatically to show the corresponding heatmap.
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
```from atomicfeaturespackage.atomicproperties import atomic_properties_dft as dft```
This module contains several atomic features accessible from FHI-AIMS dft calculations
To access atomic properties calculated from different DFT functionals and spin setting one first need to instantiate Specific functional and spin setting one is interested to access using the method function of this module. This can be done as follows :
```dft.method(method = 'pbe', Spin = 'False')```
Currently data evaluated are available from following functionals 'HSE06', 'REVPBE', 'PW-LDA', 'PBE' , 'PBESOL', 'PBE0'.
Spin Setting can be set to 'TRUE' or 'FALSE'.
One can now acess individually different properties using element symbol as following
```
dft.C.atomic_ea
dft.C.atomic_r_p
dft.C.atomic_ip_by_half_charged_homo
```
To get a list of properties accessible one can just press Tab after typing in `dft.C.`
Use symbol method from atomic_properties_dft module to acess property of interest of elements at once say for example we have a python list ls = ['Sc','Ti', 'V', 'Cr'] and we wish to get atomic number of these elements we can do the following
```
atomic_number = []
for i in ls:
atomic_number.append(dft.symbol(i).atomic_number)
```
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
```from atomicfeaturespackage.atomicproperties import atomic_properties_pymat as pymat```
This module contains several atomic features accessible from pymatgen
One can now acess individually different properties using element symbol as following
```
pymat.C.atomic_ea
pymat.C.atomic_r_p
pymat.C.atomic_ip_by_half_charged_homo
```
To get a list of properties accessible one can just press Tab after typing in `pymat.C.`
Use symbol method from atomic_properties_pymat module to acess property of interest of elements at once in similar manner as described for atomic_properties_dft module above.
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
```from atomicfeaturespackage.atomicproperties import atomic_properties_lda2015 as lda```
This module contains several atomic features accessible from lda2015 paper
One can acess individually different properties using element symbol as following
```
lda.C.atomic_ea
lda.C.atomic_r_p
```
To get a list of properties accessible one can just press Tab after typing in `lda.C.`
Use symbol method from atomic_properties_lda2015 module to acess property of interest of elements at once in similar manner as described for atomic_properties_dft module above.
**-------------------------------------------------------------------------------------------------------------------------------------------------------**
...@@ -10,7 +10,9 @@ Welcome to atomic-features-package's documentation! ...@@ -10,7 +10,9 @@ Welcome to atomic-features-package's documentation!
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
modules.rst ../README.md
atomicfeaturespackage.rst
......
...@@ -84,16 +84,25 @@ ...@@ -84,16 +84,25 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">atomicfeaturespackage</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="atomicfeaturespackage.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">atomicfeaturespackage.atomicproperties package</a></li> <li class="toctree-l1 current"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="atomicfeaturespackage.metainfo.html">atomicfeaturespackage.metainfo package</a></li> <li class="toctree-l2 current"><a class="reference internal" href="atomicfeaturespackage.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">atomicfeaturespackage.atomicproperties package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.atomicproperties.atomic_properties_dft">atomicfeaturespackage.atomicproperties.atomic_properties_dft module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.atomicproperties.atomic_properties_lda2015">atomicfeaturespackage.atomicproperties.atomic_properties_lda2015 module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.atomicproperties.atomic_properties_magpie">atomicfeaturespackage.atomicproperties.atomic_properties_magpie module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.atomicproperties.atomic_properties_pymat">atomicfeaturespackage.atomicproperties.atomic_properties_pymat module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.atomicproperties.periodictable">atomicfeaturespackage.atomicproperties.periodictable module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.atomicproperties">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="atomicfeaturespackage.html#module-atomicfeaturespackage">Module contents</a></li> <li class="toctree-l3"><a class="reference internal" href="atomicfeaturespackage.metainfo.html">atomicfeaturespackage.metainfo package</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="atomicfeaturespackage.html#module-atomicfeaturespackage">Module contents</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -142,8 +151,6 @@ ...@@ -142,8 +151,6 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="modules.html">atomicfeaturespackage</a> &raquo;</li>
<li><a href="atomicfeaturespackage.html">atomicfeaturespackage package</a> &raquo;</li> <li><a href="atomicfeaturespackage.html">atomicfeaturespackage package</a> &raquo;</li>
<li>atomicfeaturespackage.atomicproperties package</li> <li>atomicfeaturespackage.atomicproperties package</li>
......
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="atomicfeaturespackage.atomicproperties package" href="atomicfeaturespackage.atomicproperties.html" /> <link rel="next" title="atomicfeaturespackage.atomicproperties package" href="atomicfeaturespackage.atomicproperties.html" />
<link rel="prev" title="atomicfeaturespackage" href="modules.html" /> <link rel="prev" title="Description" href="README.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
...@@ -84,16 +84,16 @@ ...@@ -84,16 +84,16 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">atomicfeaturespackage</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">atomicfeaturespackage package</a><ul> <li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul> <li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l4"><a class="reference internal" href="atomicfeaturespackage.atomicproperties.html">atomicfeaturespackage.atomicproperties package</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">atomicfeaturespackage package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="atomicfeaturespackage.metainfo.html">atomicfeaturespackage.metainfo package</a></li> <li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
</ul> <li class="toctree-l3"><a class="reference internal" href="atomicfeaturespackage.atomicproperties.html">atomicfeaturespackage.atomicproperties package</a></li>
</li> <li class="toctree-l3"><a class="reference internal" href="atomicfeaturespackage.metainfo.html">atomicfeaturespackage.metainfo package</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-atomicfeaturespackage">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#module-atomicfeaturespackage">Module contents</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -142,8 +142,6 @@ ...@@ -142,8 +142,6 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="modules.html">atomicfeaturespackage</a> &raquo;</li>
<li>atomicfeaturespackage package</li> <li>atomicfeaturespackage package</li>
...@@ -205,7 +203,7 @@ ...@@ -205,7 +203,7 @@
<a href="atomicfeaturespackage.atomicproperties.html" class="btn btn-neutral float-right" title="atomicfeaturespackage.atomicproperties package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="atomicfeaturespackage.atomicproperties.html" class="btn btn-neutral float-right" title="atomicfeaturespackage.atomicproperties package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="modules.html" class="btn btn-neutral float-left" title="atomicfeaturespackage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="README.html" class="btn btn-neutral float-left" title="Description" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>
......
...@@ -83,16 +83,21 @@ ...@@ -83,16 +83,21 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">atomicfeaturespackage</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="atomicfeaturespackage.html#subpackages">Subpackages</a><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l4"><a class="reference internal" href="atomicfeaturespackage.atomicproperties.html">atomicfeaturespackage.atomicproperties package</a></li> <li class="toctree-l1 current"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">atomicfeaturespackage.metainfo package</a></li> <li class="toctree-l2 current"><a class="reference internal" href="atomicfeaturespackage.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="atomicfeaturespackage.atomicproperties.html">atomicfeaturespackage.atomicproperties package</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">atomicfeaturespackage.metainfo package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.metainfo.metainfo">atomicfeaturespackage.metainfo.metainfo module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-atomicfeaturespackage.metainfo">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l3"><a class="reference internal" href="atomicfeaturespackage.html#module-atomicfeaturespackage">Module contents</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="atomicfeaturespackage.html#module-atomicfeaturespackage">Module contents</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -141,8 +146,6 @@ ...@@ -141,8 +146,6 @@
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li> <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="modules.html">atomicfeaturespackage</a> &raquo;</li>
<li><a href="atomicfeaturespackage.html">atomicfeaturespackage package</a> &raquo;</li> <li><a href="atomicfeaturespackage.html">atomicfeaturespackage package</a> &raquo;</li>
<li>atomicfeaturespackage.metainfo package</li> <li>atomicfeaturespackage.metainfo package</li>
......
...@@ -83,7 +83,10 @@ ...@@ -83,7 +83,10 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">atomicfeaturespackage</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li>
</ul> </ul>
......
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="atomicfeaturespackage" href="modules.html" /> <link rel="next" title="Description" href="README.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
...@@ -83,7 +83,10 @@ ...@@ -83,7 +83,10 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">atomicfeaturespackage</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li>
</ul> </ul>
...@@ -154,8 +157,12 @@ ...@@ -154,8 +157,12 @@
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">atomicfeaturespackage</a><ul> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="atomicfeaturespackage.html#subpackages">Subpackages</a></li>
<li class="toctree-l2"><a class="reference internal" href="atomicfeaturespackage.html#module-atomicfeaturespackage">Module contents</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -178,7 +185,7 @@ ...@@ -178,7 +185,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="modules.html" class="btn btn-neutral float-right" title="atomicfeaturespackage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="README.html" class="btn btn-neutral float-right" title="Description" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div> </div>
......
...@@ -35,9 +35,7 @@ ...@@ -35,9 +35,7 @@
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="atomicfeaturespackage package" href="atomicfeaturespackage.html" />
<link rel="prev" title="Welcome to atomic-features-package’s documentation!" href="index.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
...@@ -83,11 +81,11 @@ ...@@ -83,11 +81,11 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current"> <ul>
<li class="toctree-l1 current"><a class="current reference internal" href="#">atomicfeaturespackage</a><ul> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
</ul> <li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
</li> <li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li>
</ul> </ul>
...@@ -190,15 +188,6 @@ ...@@ -190,15 +188,6 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="atomicfeaturespackage.html" class="btn btn-neutral float-right" title="atomicfeaturespackage package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to atomic-features-package’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/> <hr/>
......
No preview for this file type
...@@ -85,7 +85,10 @@ ...@@ -85,7 +85,10 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">atomicfeaturespackage</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li>
</ul> </ul>
......
...@@ -84,7 +84,10 @@ ...@@ -84,7 +84,10 @@
<p class="caption"><span class="caption-text">Contents:</span></p> <p class="caption"><span class="caption-text">Contents:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">atomicfeaturespackage</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#getting-started">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#importing-this-package-modules-in-jupyter-notebook">Importing this package modules in Jupyter notebook</a></li>
<li class="toctree-l1"><a class="reference internal" href="atomicfeaturespackage.html">atomicfeaturespackage package</a></li>
</ul> </ul>
......
This diff is collapsed.
...@@ -27,7 +27,7 @@ author = 'Aakash Naik' ...@@ -27,7 +27,7 @@ author = 'Aakash Naik'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['sphinx.ext.autodoc'] extensions = ['sphinx.ext.autodoc','recommonmark']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment