update documentation

liborsold · Sep 25, 2024 · 9632ce2 · 9632ce2
1 parent d1437ea
commit 9632ce2
Show file tree

Hide file tree

Showing 20 changed files with 110 additions and 465 deletions.
diff --git a/docs/build/doctrees/classes.doctree b/docs/build/doctrees/classes.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -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: 271ccceea0cadb72bca2be5deb05d823
+config: f2aa3bf618c43db92f1fe90f33a74eeb
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/index.rst b/docs/build/html/_sources/index.rst
@@ -14,9 +14,10 @@ Contents
 --------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
-   api
+   modules
+   classes
 
 Indices and tables
 ==================

diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.1',
+    VERSION: '0.1.11',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/build/html/api.html b/docs/build/html/api.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>API &#8212; fuNEGF 0.1.1 documentation</title>
+    <title>API &#8212; fuNEGF 0.1.11 documentation</title>
 
 
 
@@ -36,7 +36,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=1a9ffd16"></script>
+    <script src="_static/documentation_options.js?v=86f9da5d"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -132,7 +132,7 @@
 
 
 
-    <p class="title logo__title">fuNEGF 0.1.1 documentation</p>
+    <p class="title logo__title"><b>fuNEGF</b> 0.1.11 documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -153,6 +153,7 @@
 <li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
 </ul>
 </details></li>
+<li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 </ul>
 
     </div>

diff --git a/docs/build/html/classes.html b/docs/build/html/classes.html
diff --git a/docs/build/html/generated/fuNEGF.html b/docs/build/html/generated/fuNEGF.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>fuNEGF &#8212; fuNEGF 0.1.1 documentation</title>
+    <title>fuNEGF &#8212; fuNEGF 0.1.11 documentation</title>
 
 
 
@@ -36,7 +36,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=1a9ffd16"></script>
+    <script src="../_static/documentation_options.js?v=86f9da5d"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -132,7 +132,7 @@
 
 
 
-    <p class="title logo__title">fuNEGF 0.1.1 documentation</p>
+    <p class="title logo__title"><b>fuNEGF</b> 0.1.11 documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -149,10 +149,11 @@
         <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
     <div class="bd-toc-item navbar-nav active">
         <ul class="nav bd-sidenav">
-<li class="toctree-l1 has-children"><a class="reference internal" href="../api.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="fuNEGF.models.html">fuNEGF.models</a></li>
 </ul>
 </details></li>
+<li class="toctree-l1"><a class="reference internal" href="../classes.html">Classes</a></li>
 </ul>
 
     </div>

diff --git a/docs/build/html/generated/fuNEGF.models.html b/docs/build/html/generated/fuNEGF.models.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>fuNEGF.models &#8212; fuNEGF 0.1.1 documentation</title>
+    <title>fuNEGF.models &#8212; fuNEGF 0.1.11 documentation</title>
 
 
 
@@ -36,14 +36,15 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=1a9ffd16"></script>
+    <script src="../_static/documentation_options.js?v=86f9da5d"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'generated/fuNEGF.models';</script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="prev" title="API" href="../api.html" />
+    <link rel="next" title="Classes" href="../classes.html" />
+    <link rel="prev" title="API" href="../modules.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -131,7 +132,7 @@
 
 
 
-    <p class="title logo__title">fuNEGF 0.1.1 documentation</p>
+    <p class="title logo__title"><b>fuNEGF</b> 0.1.11 documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -148,10 +149,11 @@
         <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
     <div class="bd-toc-item navbar-nav active">
         <ul class="current nav bd-sidenav">
-<li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l1 current active has-children"><a class="reference internal" href="../modules.html">API</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
 <li class="toctree-l2 current active"><a class="current reference internal" href="#">fuNEGF.models</a></li>
 </ul>
 </details></li>
+<li class="toctree-l1"><a class="reference internal" href="../classes.html">Classes</a></li>
 </ul>
 
     </div>
@@ -343,14 +345,23 @@ <h1>fuNEGF.models</h1>
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="../api.html"
+       href="../modules.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
         <p class="prev-next-title">API</p>
       </div>
     </a>
+    <a class="right-next"
+       href="../classes.html"
+       title="next page">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">next</p>
+        <p class="prev-next-title">Classes</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
 </div>
                 </footer>
 

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; fuNEGF 0.1.1 documentation</title>
+    <title>Index &#8212; fuNEGF 0.1.11 documentation</title>
 
 
 
@@ -35,7 +35,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=1a9ffd16"></script>
+    <script src="_static/documentation_options.js?v=86f9da5d"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
@@ -131,7 +131,7 @@
 
 
 
-    <p class="title logo__title">fuNEGF 0.1.1 documentation</p>
+    <p class="title logo__title"><b>fuNEGF</b> 0.1.11 documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item">
@@ -148,10 +148,11 @@
         <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
     <div class="bd-toc-item navbar-nav active">
         <ul class="nav bd-sidenav">
-<li class="toctree-l1 has-children"><a class="reference internal" href="api.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
 </ul>
 </details></li>
+<li class="toctree-l1"><a class="reference internal" href="classes.html">Classes</a></li>
 </ul>
 
     </div>
@@ -275,25 +276,15 @@ <h1 id="index">Index</h1>
 <div class="genindex-jumpbox">
  <a href="#A"><strong>A</strong></a>
  | <a href="#C"><strong>C</strong></a>
- | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
- | <a href="#H"><strong>H</strong></a>
- | <a href="#K"><strong>K</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
- | <a href="#N"><strong>N</strong></a>
  | <a href="#P"><strong>P</strong></a>
- | <a href="#S"><strong>S</strong></a>
- | <a href="#T"><strong>T</strong></a>
 
 </div>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.a">a (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="classes.html#fuNEGF.models.LinearChain.add_H_impurity">add_H_impurity() (fuNEGF.models.LinearChain method)</a>
 </li>
@@ -312,27 +303,9 @@ <h2 id="C">C</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="E">E</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.E_levels">E_levels (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.E_vs_k_fun">E_vs_k_fun (fuNEGF.models.LinearChain attribute)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.eps_0">eps_0 (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.f_1">f_1 (fuNEGF.models.LinearChain attribute)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.f_2">f_2 (fuNEGF.models.LinearChain attribute)</a>
-</li>
       <li>
     fuNEGF
 
@@ -356,42 +329,14 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="classes.html#fuNEGF.models.LinearChain.G_R_fun">G_R_fun() (fuNEGF.models.LinearChain method)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Gamma_1_fun_k">Gamma_1_fun_k (fuNEGF.models.LinearChain attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Gamma_2_fun_k">Gamma_2_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
       <li><a href="classes.html#fuNEGF.models.LinearChain.Greens_functions_solver">Greens_functions_solver() (fuNEGF.models.LinearChain method)</a>
 </li>
   </ul></td>
 </tr></table>
 
-<h2 id="H">H</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.H">H (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.H_impurity">H_impurity (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
-<h2 id="K">K</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.k_states">k_states (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.k_vs_E_fun">k_vs_E_fun (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -403,8 +348,6 @@ <h2 id="L">L</h2>
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.make_H_periodic">make_H_periodic (fuNEGF.models.LinearChain attribute)</a>
-</li>
       <li>
     module
 
@@ -417,19 +360,9 @@ <h2 id="M">M</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="N">N</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.N">N (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.plot_dispersion">plot_dispersion (fuNEGF.models.LinearChain attribute)</a>
-</li>
       <li><a href="classes.html#fuNEGF.models.LinearChain.plot_occupation">plot_occupation() (fuNEGF.models.LinearChain method)</a>
 </li>
   </ul></td>
@@ -441,34 +374,6 @@ <h2 id="P">P</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="S">S</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Sigma_1_fun_k">Sigma_1_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Sigma_2_fun_k">Sigma_2_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Sigma_fun_k">Sigma_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Sigma_in_1_fun_k">Sigma_in_1_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Sigma_in_2_fun_k">Sigma_in_2_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.Sigma_in_fun_k">Sigma_in_fun_k (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
-<h2 id="T">T</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="classes.html#fuNEGF.models.LinearChain.t">t (fuNEGF.models.LinearChain attribute)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 
 
                 </article>