Skip to content

Commit

Permalink
Generated documentation for triqs/unstable
Browse files Browse the repository at this point in the history
jenkins-TRIQS-triqs-unstable-996 c9f0ce2375bdd5d0f50f22a3fac4a60d9fd92956
  • Loading branch information
flatiron-jenkins committed Jul 22, 2024
1 parent f2e92bd commit 17ac747
Show file tree
Hide file tree
Showing 24 changed files with 34 additions and 34 deletions.
14 changes: 7 additions & 7 deletions triqs/unstable/_modules/triqs/dos/dos.html
Original file line number Diff line number Diff line change
Expand Up @@ -1782,7 +1782,7 @@ <h1>Source code for triqs.dos.dos</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">numpy</span>

<div class="viewcode-block" id="DOS">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/dos.html#triqs.dos.DOS">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOS.html#triqs.dos.dos.DOS">[docs]</a>
<span class="k">class</span> <span class="nc">DOS</span> <span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">* Stores a density of state of fermions </span>
Expand All @@ -1801,7 +1801,7 @@ <h1>Source code for triqs.dos.dos</h1><div class="highlight"><pre>

<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="DOS.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOS.__init__.html#triqs.dos.DOS.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOS.__init__.html#triqs.dos.dos.DOS.__init__">[docs]</a>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eps</span><span class="p">,</span> <span class="n">rho</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; </span>
<span class="sd">Parameters </span>
Expand Down Expand Up @@ -1847,7 +1847,7 @@ <h1>Source code for triqs.dos.dos</h1><div class="highlight"><pre>
<span class="s2"> &quot;&quot;&quot;</span><span class="o">%</span><span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span>

<div class="viewcode-block" id="DOS.copy">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/dos.html#triqs.dos.DOS.copy">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOS.copy.html#triqs.dos.dos.DOS.copy">[docs]</a>
<span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">DOS</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">eps</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">rho</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span></div>

Expand All @@ -1856,7 +1856,7 @@ <h1>Source code for triqs.dos.dos</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="p">[</span> <span class="p">{</span><span class="s1">&#39;label&#39;</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;xlabel&#39;</span> <span class="p">:</span><span class="sa">r</span><span class="s1">&#39;$\epsilon$&#39;</span><span class="p">,</span> <span class="s1">&#39;ylabel&#39;</span> <span class="p">:</span> <span class="sa">r</span><span class="s1">&#39;</span><span class="si">%s</span><span class="s1">$(\epsilon)$&#39;</span><span class="o">%</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;xdata&#39;</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">eps</span><span class="p">,</span><span class="s1">&#39;ydata&#39;</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">rho</span> <span class="p">}</span> <span class="p">]</span>

<div class="viewcode-block" id="DOS.density">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/dos.html#triqs.dos.DOS.density">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOS.density.html#triqs.dos.dos.DOS.density">[docs]</a>
<span class="k">def</span> <span class="nf">density</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">mu</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Calculates the density of free fermions for the given DOS for chemical potential mu.&quot;&quot;&quot;</span>

Expand All @@ -1880,7 +1880,7 @@ <h1>Source code for triqs.dos.dos</h1><div class="highlight"><pre>
<span class="c1">##########################################################################</span>

<div class="viewcode-block" id="dos_from_file">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/dos.html#triqs.dos.dos_from_file">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.dos_from_file.html#triqs.dos.dos.dos_from_file">[docs]</a>
<span class="k">def</span> <span class="nf">dos_from_file</span><span class="p">(</span><span class="n">Filename</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">single_orbital</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; </span>
<span class="sd"> Read the DOS from a file </span>
Expand Down Expand Up @@ -1921,15 +1921,15 @@ <h1>Source code for triqs.dos.dos</h1><div class="highlight"><pre>
<span class="c1">##########################################################################</span>

<div class="viewcode-block" id="DOSFromFunction">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/dos.html#triqs.dos.DOSFromFunction">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOSFromFunction.html#triqs.dos.dos.DOSFromFunction">[docs]</a>
<span class="k">class</span> <span class="nc">DOSFromFunction</span><span class="p">(</span><span class="n">DOS</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> * A DOS class, but constructed from a function.</span>
<span class="sd"> </span>
<span class="sd"> * The number of points can be variable and self-adjusted in the Hilbert transform to adapt precision.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="DOSFromFunction.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOSFromFunction.__init__.html#triqs.dos.DOSFromFunction.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.dos.DOSFromFunction.__init__.html#triqs.dos.dos.DOSFromFunction.__init__">[docs]</a>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">x_min</span><span class="p">,</span> <span class="n">x_max</span><span class="p">,</span> <span class="n">n_pts</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> :param function: * a function :math:`\\epsilon \\rightarrow \\rho(\\epsilon)`</span>
Expand Down
6 changes: 3 additions & 3 deletions triqs/unstable/_modules/triqs/dos/hilbert_transform.html
Original file line number Diff line number Diff line change
Expand Up @@ -1785,7 +1785,7 @@ <h1>Source code for triqs.dos.hilbert_transform</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">numpy</span>

<div class="viewcode-block" id="HilbertTransform">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/hilbert.html#triqs.dos.HilbertTransform">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.hilbert_transform.HilbertTransform.html#triqs.dos.hilbert_transform.HilbertTransform">[docs]</a>
<span class="k">class</span> <span class="nc">HilbertTransform</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Computes the Hilbert Transform from a DOS object</span>
Expand All @@ -1798,7 +1798,7 @@ <h1>Source code for triqs.dos.hilbert_transform</h1><div class="highlight"><pre>

<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="HilbertTransform.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.hilbert_transform.HilbertTransform.__init__.html#triqs.dos.HilbertTransform.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.dos.hilbert_transform.HilbertTransform.__init__.html#triqs.dos.hilbert_transform.HilbertTransform.__init__">[docs]</a>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rho</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> :param rho: a DOS object.</span>
Expand Down Expand Up @@ -1829,7 +1829,7 @@ <h1>Source code for triqs.dos.hilbert_transform</h1><div class="highlight"><pre>
<span class="c1">#-------------------------------------------------------------</span>

<div class="viewcode-block" id="HilbertTransform.__call__">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/hilbert.html#triqs.dos.HilbertTransform.__call__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/hilbert.html#triqs.dos.hilbert_transform.HilbertTransform.__call__">[docs]</a>
<span class="k">def</span> <span class="fm">__call__</span> <span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">Sigma</span><span class="p">,</span> <span class="n">mu</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">eta</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">field</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">epsilon_hat</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">result</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">n_points_integral</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">test_convergence</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
Expand Down
4 changes: 2 additions & 2 deletions triqs/unstable/_modules/triqs/gf/descriptors.html
Original file line number Diff line number Diff line change
Expand Up @@ -1832,7 +1832,7 @@ <h1>Source code for triqs.gf.descriptors</h1><div class="highlight"><pre>
<span class="c1">##################################################</span>

<div class="viewcode-block" id="SemiCircular">
<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.html#triqs.gf.descriptors.SemiCircular">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptors.SemiCircular.html#triqs.gf.descriptors.SemiCircular">[docs]</a>
<span class="k">class</span> <span class="nc">SemiCircular</span> <span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Hilbert transform of a semicircular density of states, i.e.</span>

Expand Down Expand Up @@ -1885,7 +1885,7 @@ <h1>Source code for triqs.gf.descriptors</h1><div class="highlight"><pre>
<span class="c1">##################################################</span>

<div class="viewcode-block" id="Flat">
<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.html#triqs.gf.descriptors.Flat">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptors.Flat.html#triqs.gf.descriptors.Flat">[docs]</a>
<span class="k">class</span> <span class="nc">Flat</span> <span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;The Hilbert transform of a flat density of states, with cut-off</span>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Documentation
Returns
^^^^^^^

Reference to the derived iterator after calling the derived iterator's `increment()` function.
Copy of the derived iterator before calling the derived iterator's `increment()` function.
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Parameters
Returns
^^^^^^^

True, if the first iterator, i.e. `std::get<0>(its)`, is equal to the iterator of the sentinel.
True, if all original iterators are equal.
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Parameters
Returns
^^^^^^^

True, if one of the original iterators is equal to the corresponding iterator of the sentinel.
True, if all original iterators are equal.
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ Parameters
Returns
^^^^^^^

The result of the reduction.
std::vector containing the result of each individual reduction.
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Documentation
Returns
^^^^^^^

Reference to the storage container
Constant reference to the storage container
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Parameters
Returns
^^^^^^^

Reference to the requested amplitude
Constant reference to the requested amplitude
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Parameters
Returns
^^^^^^^

Reference to the requested amplitude
Constant reference to the requested amplitude
Original file line number Diff line number Diff line change
Expand Up @@ -1807,7 +1807,7 @@
<p>Documentation</p>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>Reference to the derived iterator after calling the derived iterator’s <cite>increment()</cite> function.</p>
<p>Copy of the derived iterator before calling the derived iterator’s <cite>increment()</cite> function.</p>
</section>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1825,7 +1825,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
</section>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>True, if the first iterator, i.e. <cite>std::get&lt;0&gt;(its)</cite>, is equal to the iterator of the sentinel.</p>
<p>True, if all original iterators are equal.</p>
</section>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1825,7 +1825,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
</section>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>True, if one of the original iterators is equal to the corresponding iterator of the sentinel.</p>
<p>True, if all original iterators are equal.</p>
</section>
</section>

Expand Down
2 changes: 1 addition & 1 deletion triqs/unstable/documentation/cpp_api/mpi/mpi_reduce.html
Original file line number Diff line number Diff line change
Expand Up @@ -1835,7 +1835,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
</section>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>The result of the reduction.</p>
<p>std::vector containing the result of each individual reduction.</p>
</section>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1811,7 +1811,7 @@
</div></blockquote>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>Reference to the storage container</p>
<p>Constant reference to the storage container</p>
</section>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1819,7 +1819,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
</section>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>Reference to the requested amplitude</p>
<p>Constant reference to the requested amplitude</p>
</section>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1819,7 +1819,7 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this headi
</section>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2>
<p>Reference to the requested amplitude</p>
<p>Constant reference to the requested amplitude</p>
</section>
</section>

Expand Down
2 changes: 1 addition & 1 deletion triqs/unstable/searchindex.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2093,7 +2093,7 @@ <h2>Dynamical mean-field theory<a class="headerlink" href="#Dynamical-mean-field
\Big( \sum_k \frac{1}{i \omega_n + \mu - \epsilon_k - \Sigma_\mathrm{imp}} \Big)^{-1}
+ \Sigma_\mathrm{imp}\]</div>
<p>We solve the quantum impurity for this new <span class="math notranslate nohighlight">\(G_0\)</span> and loop until convergence</p>
<p><img alt="fdb776869f2543f39014f5a022abcce9" class="no-scaled-link" src="../../../../_images/selfcons.png" style="width: 40%;" /></p>
<p><img alt="964a1c0867064e478ab0b78662c3dd37" class="no-scaled-link" src="../../../../_images/selfcons.png" style="width: 40%;" /></p>
</section>
<section id="Bethe-lattice-DMFT">
<h2>Bethe lattice DMFT<a class="headerlink" href="#Bethe-lattice-DMFT" title="Link to this heading"></a></h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2057,7 +2057,7 @@
<section id="General-reminder:-Anderson-impurity-model-and-CTHYB-solver">
<h1>General reminder: Anderson impurity model and CTHYB solver<a class="headerlink" href="#General-reminder:-Anderson-impurity-model-and-CTHYB-solver" title="Link to this heading"></a></h1>
<p>In the Anderson impurity model, we decompose the full lattice problem into an interacting site (‘impurity’) hybridised to a bath:</p>
<p><img alt="afad2bdf47664d43bf3e84e60ee40c04" src="../../../../_images/dmft_bath_impurity.png" /></p>
<p><img alt="31958b32764047969030be0143dce5d4" src="../../../../_images/dmft_bath_impurity.png" /></p>
<dl>
<dt>with the Hamiltonian :nbsphinx-math:<a href="#id1"><span class="problematic" id="id2">`</span></a>begin{align*}</dt><dd><blockquote>
<div><p>H = &amp; color{red}{H_{rm imp}} + color{darkgreen}{H_{rm hyb}} + color{blue}{H_{rm bath}} \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2058,7 +2058,7 @@ <h1>Valence-Bond DMFT solution of the Hubbard model<a class="headerlink" href="#
<p>.</p>
<p>In the following, we use <span class="math notranslate nohighlight">\(U/t=10\)</span> and <span class="math notranslate nohighlight">\(t'/t=-0.3\)</span>, which are values commonly used for modeling hole-doped cuprates in a single-band framework. All energies (and temperatures) are expressed in units of <span class="math notranslate nohighlight">\(D=4t=1\)</span>, and the doping is denoted by <span class="math notranslate nohighlight">\(\delta\)</span>.</p>
<p>We subdivide the Brillouin Zone into a minimal set of two patches of <strong>equal</strong> area <span class="math notranslate nohighlight">\(P_+\)</span> (even) and <span class="math notranslate nohighlight">\(P_-\)</span> (odd).</p>
<p><img alt="0035cd88f5134d2ebf060f4d17ea19e7" class="no-scaled-link" src="../../../../_images/vb-patching.png" style="width: 240px; height: 180px;" /></p>
<p><img alt="9fe92746eede46609eb167e32a08096e" class="no-scaled-link" src="../../../../_images/vb-patching.png" style="width: 240px; height: 180px;" /></p>
<p><span class="math notranslate nohighlight">\(P_+\)</span> is a central square centered at momentum <span class="math notranslate nohighlight">\((0,0)\)</span> and containing the nodal region; the complementary region <span class="math notranslate nohighlight">\(P_{-}\)</span> extends to the edge of the BZ and contains in particular the antinodal region and the <span class="math notranslate nohighlight">\((\pi,\pi)\)</span> momentum.</p>
<div class="nbinput nblast docutils container">
<div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[2]:
Expand Down
Loading

0 comments on commit 17ac747

Please sign in to comment.