update documentation

docs/build/html/_sources/index.rst

@@ -3,15 +3,37 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+==================================
 Welcome to fuNEGF's documentation!
 ==================================
 
-**fuNEGF** is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green's Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.
+The `fuNEGF project <https://github.com/liborsold/fuNEGF/>`_ is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green's Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.
+
+.. fuNEGF example image
+.. image::
+   ./_images/example_fuNEGF.png
+   :width: 650px
+   :align: center
+
+
+Quickstart
+================
+
+.. code-block:: python
+   
+   pip install fuNEGF
+
+then 
+
+.. code-block:: python
+   
+   git clone https://github.com/liborsold/fuNEGF.git
+   
+and execute the ``./examples/one-dimensional_channel.ipynb`` Jupyter notebook to see an example of calculating the NEGF transmission and chemical potential in the presence of impurities.
 
-See the `fuNEGF project on GitHub <https://github.com/liborsold/fuNEGF/tree/master>`_.
 
-Contents
---------
+Navigation
+==========
 
 .. toctree::
    :maxdepth: 3

docs/build/html/index.html

@@ -318,13 +318,10 @@ <h2> Contents </h2>
             </div>
             <nav aria-label="Page">
                 <ul class="visible nav section-nav flex-column">
-<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Welcome to fuNEGF’s documentation!</a><ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contents">Contents</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#quickstart">Quickstart</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#navigation">Navigation</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#indices-and-tables">Indices and tables</a></li>
 </ul>
-</li>
-<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#indices-and-tables">Indices and tables</a></li>
-</ul>
-
             </nav>
         </div>
     </div>
@@ -337,10 +334,21 @@ <h2> Contents </h2>
 
   <section id="welcome-to-funegf-s-documentation">
 <h1>Welcome to fuNEGF’s documentation!<a class="headerlink" href="#welcome-to-funegf-s-documentation" title="Link to this heading">#</a></h1>
-<p><strong>fuNEGF</strong> is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green’s Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.</p>
-<p>See the <a class="reference external" href="https://github.com/liborsold/fuNEGF/tree/master">fuNEGF project on GitHub</a>.</p>
-<section id="contents">
-<h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">#</a></h2>
+<p>The <a class="reference external" href="https://github.com/liborsold/fuNEGF/">fuNEGF project</a> is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green’s Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.</p>
+<a class="reference internal image-reference" href="_images/example_fuNEGF.png"><img alt="_images/example_fuNEGF.png" class="align-center" src="_images/example_fuNEGF.png" style="width: 650px;" /></a>
+<section id="quickstart">
+<h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading">#</a></h2>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">fuNEGF</span>
+</pre></div>
+</div>
+<p>then</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">liborsold</span><span class="o">/</span><span class="n">fuNEGF</span><span class="o">.</span><span class="n">git</span>
+</pre></div>
+</div>
+<p>and execute the <code class="docutils literal notranslate"><span class="pre">./examples/one-dimensional_channel.ipynb</span></code> Jupyter notebook to see an example of calculating the NEGF transmission and chemical potential in the presence of impurities.</p>
+</section>
+<section id="navigation">
+<h2>Navigation<a class="headerlink" href="#navigation" title="Link to this heading">#</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">API</a><ul>
@@ -364,14 +372,14 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
 </ul>
 </div>
 </section>
-</section>
 <section id="indices-and-tables">
-<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">#</a></h1>
+<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">#</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
 <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
 </ul>
+</section>
 </section>
 
 
@@ -410,13 +418,10 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li
   </div>
   <nav class="bd-toc-nav page-toc">
     <ul class="visible nav section-nav flex-column">
-<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Welcome to fuNEGF’s documentation!</a><ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contents">Contents</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#quickstart">Quickstart</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#navigation">Navigation</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#indices-and-tables">Indices and tables</a></li>
 </ul>
-</li>
-<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#indices-and-tables">Indices and tables</a></li>
-</ul>
-
   </nav></div>
 
 </div></div>