Skip to content

Commit

Permalink
update example in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Libor Vojacek committed Oct 10, 2024
1 parent a8f3c04 commit a9d3e1e
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 1 deletion.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/example.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/build/html/_sources/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ There is also a time-complexity study in ``./examples/time_complexity.ipynb``.
.. code-block:: python
from fuNEGF.models import LinearChain
import numpy as np
chain = LinearChain(N=100, eps_0=0.0, t=1.0, a=1.0, H_impurity=None, plot_dispersion=True)
Expand Down
1 change: 1 addition & 0 deletions docs/build/html/example.html
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ <h1>Example<a class="headerlink" href="#example" title="Permalink to this headin
<div class="section" id="linear-chain-tight-binding-hamiltonian">
<h2>1. Linear-chain tight-binding Hamiltonian<a class="headerlink" href="#linear-chain-tight-binding-hamiltonian" title="Permalink to this heading">#</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">fuNEGF.models</span> <span class="kn">import</span> <span class="n">LinearChain</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

<span class="n">chain</span> <span class="o">=</span> <span class="n">LinearChain</span><span class="p">(</span><span class="n">N</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">eps_0</span><span class="o">=</span><span class="mf">0.0</span><span class="p">,</span> <span class="n">t</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">a</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">H_impurity</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">plot_dispersion</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
Expand Down
Loading

0 comments on commit a9d3e1e

Please sign in to comment.