update docs

liborsold · Apr 12, 2024 · dd7db63 · dd7db63
1 parent cbe834a
commit dd7db63
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 3 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/html/_sources/classes.rst.txt b/docs/build/html/_sources/classes.rst.txt
@@ -1,7 +1,7 @@
 Classes
 ==============
 
-For now, there is only the LinearChain class, including both the model and NEGF solver routines. This will be in future separated into a generic System class, with child classes of different specific systems (like LinearChain). 
+For now, there is the LinearChain class including both the model and NEGF solver routines. This will be in future separated into a generic System class, with child classes of different specific systems (like LinearChain). 
 
 .. autoclass:: fuNEGF.models.LinearChain
     :members:

diff --git a/docs/build/html/classes.html b/docs/build/html/classes.html
@@ -32,7 +32,7 @@
 
   <section id="classes">
 <h1>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶</a></h1>
-<p>For now, there is only the LinearChain class, including both the model and NEGF solver routines. This will be in future separated into a generic System class, with child classes of different specific systems (like LinearChain).</p>
+<p>For now, there is the LinearChain class including both the model and NEGF solver routines. This will be in future separated into a generic System class, with child classes of different specific systems (like LinearChain).</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="fuNEGF.models.LinearChain">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">fuNEGF.models.</span></span><span class="sig-name descname"><span class="pre">LinearChain</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">N</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps_0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">a</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">H_impurity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">make_H_periodic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_dispersion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#fuNEGF.models.LinearChain" title="Link to this definition">¶</a></dt>