Generated documentation for triqs/3.3.x

jenkins-TRIQS-triqs-3.3.x-49 faa89bedd91f4a524d14a3911d32109289c5c58b
TRIQS · Nov 19, 2024 · 45d5847 · 45d5847
1 parent 5711572
commit 45d5847
Show file tree

Hide file tree

Showing 16 changed files with 56 additions and 56 deletions.
diff --git a/triqs/3.3.x/_modules/triqs/dos/dos.html b/triqs/3.3.x/_modules/triqs/dos/dos.html
@@ -1787,7 +1787,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>
@@ -1806,7 +1806,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>
@@ -1852,7 +1852,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>
 
@@ -1861,7 +1861,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>
 
@@ -1885,7 +1885,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>
@@ -1926,15 +1926,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>

diff --git a/triqs/3.3.x/_modules/triqs/dos/hilbert_transform.html b/triqs/3.3.x/_modules/triqs/dos/hilbert_transform.html
@@ -1790,7 +1790,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>
@@ -1803,7 +1803,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>
@@ -1834,7 +1834,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>

diff --git a/triqs/3.3.x/_modules/triqs/gf/backwd_compat/gf_retime.html b/triqs/3.3.x/_modules/triqs/gf/backwd_compat/gf_retime.html
@@ -1787,7 +1787,7 @@ <h1>Source code for triqs.gf.backwd_compat.gf_retime</h1><div class="highlight">
 <span class="kn">from</span> <span class="nn">triqs.gf.meshes</span> <span class="kn">import</span> <span class="n">MeshReTime</span>
 
 <div class="viewcode-block" id="GfReTime">
-<a class="viewcode-back" href="../../../../documentation/manual/triqs/gfs/py/block/GfReTime.html#triqs.gf.GfReTime">[docs]</a>
+<a class="viewcode-back" href="../../../../documentation/python_api/triqs.gf.backwd_compat.gf_retime.GfReTime.html#triqs.gf.backwd_compat.gf_retime.GfReTime">[docs]</a>
 <span class="k">class</span> <span class="nc">GfReTime</span><span class="p">(</span><span class="n">Gf</span><span class="p">)</span> <span class="p">:</span> 
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Parameters (KEYWORD argument ONLY)</span>
@@ -1816,7 +1816,7 @@ <h1>Source code for triqs.gf.backwd_compat.gf_retime</h1><div class="highlight">
 
 <span class="sd">    &quot;&quot;&quot;</span>
 <div class="viewcode-block" id="GfReTime.__init__">
-<a class="viewcode-back" href="../../../../documentation/python_api/triqs.gf.backwd_compat.gf_retime.GfReTime.__init__.html#triqs.gf.GfReTime.__init__">[docs]</a>
+<a class="viewcode-back" href="../../../../documentation/python_api/triqs.gf.backwd_compat.gf_retime.GfReTime.__init__.html#triqs.gf.backwd_compat.gf_retime.GfReTime.__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="o">**</span><span class="n">kw</span><span class="p">):</span> <span class="c1"># enforce keyword only policy </span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">          Same as Gf, but can rebuild the  mesh for backward compatibility</span>