Skip to content

Commit

Permalink
Generated documentation for triqs/3.3.x
Browse files Browse the repository at this point in the history
jenkins-TRIQS-triqs-3.3.x-53 aecb4d778f310050640dc4a34c7b71c30160dc56
  • Loading branch information
flatiron-jenkins committed Nov 22, 2024
1 parent e978684 commit d06a263
Show file tree
Hide file tree
Showing 34 changed files with 96 additions and 73 deletions.
Binary file added triqs/3.3.x/_images/logo_ccq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added triqs/3.3.x/_images/logo_cdf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed triqs/3.3.x/_images/logo_flatiron.png
Binary file not shown.
Binary file removed triqs/3.3.x/_images/logo_simons.jpg
Binary file not shown.
Binary file added triqs/3.3.x/_images/logo_simons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions triqs/3.3.x/_modules/triqs/gf/backwd_compat/gf_retime.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/python_api/triqs.gf.backwd_compat.gf_retime.GfReTime.html#triqs.gf.backwd_compat.gf_retime.GfReTime">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/manual/triqs/gfs/py/block/GfReTime.html#triqs.gf.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>
Expand Down Expand Up @@ -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.backwd_compat.gf_retime.GfReTime.__init__">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.gf.backwd_compat.gf_retime.GfReTime.__init__.html#triqs.gf.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>
Expand Down
34 changes: 17 additions & 17 deletions triqs/3.3.x/_modules/triqs/gf/block_gf.html

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions triqs/3.3.x/_modules/triqs/gf/descriptor_base.html
Original file line number Diff line number Diff line change
Expand Up @@ -1792,10 +1792,10 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">.meshes</span> <span class="kn">import</span> <span class="n">MeshImFreq</span><span class="p">,</span> <span class="n">MeshDLRImFreq</span><span class="p">,</span> <span class="n">MeshReFreq</span>

<div class="viewcode-block" id="LazyCTX">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.html#triqs.gf.descriptor_base.LazyCTX">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.html#triqs.gf.descriptors.LazyCTX">[docs]</a>
<span class="k">class</span> <span class="nc">LazyCTX</span><span class="p">:</span>
<div class="viewcode-block" id="LazyCTX.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.__init__.html#triqs.gf.descriptor_base.LazyCTX.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.LazyCTX.__init__.html#triqs.gf.descriptors.LazyCTX.__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">G</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">G</span> <span class="o">=</span> <span class="n">G</span></div>

Expand All @@ -1813,19 +1813,19 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="is_lazy">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_lazy.html#triqs.gf.descriptor_base.is_lazy">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_lazy.html#triqs.gf.descriptors.is_lazy">[docs]</a>
<span class="k">def</span> <span class="nf">is_lazy</span><span class="p">(</span><span class="n">y</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,(</span><span class="n">Omega_</span><span class="p">,</span> <span class="n">LazyExpr</span><span class="p">,</span> <span class="n">LazyExprTerminal</span><span class="p">))</span></div>


<div class="viewcode-block" id="is_scalar">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_scalar.html#triqs.gf.descriptor_base.is_scalar">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.is_scalar.html#triqs.gf.descriptors.is_scalar">[docs]</a>
<span class="k">def</span> <span class="nf">is_scalar</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span> <span class="nb">type</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="nb">type</span><span class="p">(</span><span class="mf">1.0</span><span class="p">),</span> <span class="nb">type</span><span class="p">(</span><span class="mi">1</span><span class="n">j</span><span class="p">),</span> <span class="n">numpy</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="nb">int</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int_</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int8</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int16</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">int32</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">float64</span><span class="p">,</span> <span class="nb">complex</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">complex64</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">complex128</span> <span class="p">]</span></div>


<div class="viewcode-block" id="convert_scalar_to_const">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.convert_scalar_to_const.html#triqs.gf.descriptor_base.convert_scalar_to_const">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.convert_scalar_to_const.html#triqs.gf.descriptors.convert_scalar_to_const">[docs]</a>
<span class="k">def</span> <span class="nf">convert_scalar_to_const</span><span class="p">(</span><span class="n">expr</span><span class="p">):</span>

<span class="c1"># if the expression is a pure scalar, replace it by Const</span>
Expand All @@ -1844,29 +1844,29 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Base">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.html#triqs.gf.descriptor_base.Base">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.html#triqs.gf.descriptors.Base">[docs]</a>
<span class="k">class</span> <span class="nc">Base</span> <span class="p">(</span><span class="n">LazyExprTerminal</span><span class="p">):</span>
<div class="viewcode-block" id="Base.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.__init__.html#triqs.gf.descriptor_base.Base.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Base.__init__.html#triqs.gf.descriptors.Base.__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">kargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kargs</span><span class="p">)</span></div>
</div>


<span class="c1"># The Base for any descriptor taking a BlockGf</span>
<div class="viewcode-block" id="BaseBlock">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.html#triqs.gf.descriptor_base.BaseBlock">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.html#triqs.gf.descriptors.BaseBlock">[docs]</a>
<span class="k">class</span> <span class="nc">BaseBlock</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<div class="viewcode-block" id="BaseBlock.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.__init__.html#triqs.gf.descriptor_base.BaseBlock.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.__init__.html#triqs.gf.descriptors.BaseBlock.__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">G</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="n">Base</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">G</span> <span class="o">=</span> <span class="n">G</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_block_descriptor</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">descriptor_iter</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span><span class="n">g</span> <span class="ow">in</span> <span class="n">G</span><span class="p">)</span></div>


<div class="viewcode-block" id="BaseBlock.is_block_descriptor">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.is_block_descriptor.html#triqs.gf.descriptor_base.BaseBlock.is_block_descriptor">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.BaseBlock.is_block_descriptor.html#triqs.gf.descriptors.BaseBlock.is_block_descriptor">[docs]</a>
<span class="k">def</span> <span class="nf">is_block_descriptor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">G</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;BlockGf&#39;</span></div>

Expand All @@ -1878,15 +1878,15 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
<span class="c1">#########################################################################</span>

<div class="viewcode-block" id="Function">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Function.html#triqs.gf.descriptor_base.Function">[docs]</a>
<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.html#triqs.gf.descriptors.Function">[docs]</a>
<span class="k">class</span> <span class="nc">Function</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; </span>
<span class="sd"> Stores a python function </span>
<span class="sd"> </span>
<span class="sd"> If the Green&#39;s function is defined on an array of points :math:`x_i`, then it will be initialized to :math:`F(x_i)`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="Function.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Function.__init__.html#triqs.gf.descriptor_base.Function.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Function.__init__.html#triqs.gf.descriptors.Function.__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="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> :param function: the function :math:`\omega \rightarrow function(\omega)`</span>
Expand All @@ -1908,10 +1908,10 @@ <h1>Source code for triqs.gf.descriptor_base</h1><div class="highlight"><pre>
<span class="c1">#########################################################################</span>

<div class="viewcode-block" id="Const">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.html#triqs.gf.descriptor_base.Const">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.html#triqs.gf.descriptors.Const">[docs]</a>
<span class="k">class</span> <span class="nc">Const</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<div class="viewcode-block" id="Const.__init__">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.__init__.html#triqs.gf.descriptor_base.Const.__init__">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Const.__init__.html#triqs.gf.descriptors.Const.__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">C</span><span class="p">):</span>
<span class="n">Base</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">C</span><span class="o">=</span><span class="n">C</span><span class="p">)</span></div>

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

<div class="viewcode-block" id="Omega_">
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Omega_.html#triqs.gf.descriptor_base.Omega_">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.gf.descriptor_base.Omega_.html#triqs.gf.descriptors.Omega_">[docs]</a>
<span class="k">class</span> <span class="nc">Omega_</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 function:math:`\omega \rightarrow \omega` &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">return</span> <span class="s2">&quot;Omega&quot;</span>
Expand Down
4 changes: 2 additions & 2 deletions triqs/3.3.x/_modules/triqs/gf/descriptors.html
Original file line number Diff line number Diff line change
Expand Up @@ -1837,7 +1837,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/python_api/triqs.gf.descriptors.SemiCircular.html#triqs.gf.descriptors.SemiCircular">[docs]</a>
<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.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 @@ -1890,7 +1890,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/python_api/triqs.gf.descriptors.Flat.html#triqs.gf.descriptors.Flat">[docs]</a>
<a class="viewcode-back" href="../../../documentation/manual/triqs/gfs/py/descriptors.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 @@ -48,4 +48,4 @@ Parameters
Returns
^^^^^^^

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

True, if the original iterators are equal.
True, if the original iterator is equal to the iterator stored in the sentinel.
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.
42 changes: 30 additions & 12 deletions triqs/3.3.x/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,25 +111,43 @@ You can also post an issue on the `TRIQS GitHub <https://github.com/TRIQS/triqs>

Finally, if you want to contribute to the project, please check our :ref:`Contributing <triqs_contributing>` section.

.. raw:: html

<style>
.img {
margin-right: 2%;
}
</style>

.. image:: _static/logo_simons.png
:width: 19.0%
:target: https://www.simonsfoundation.org
:class: img

.. image:: _static/logo_ccq.png
:width: 32.6%
:target: https://www.simonsfoundation.org/flatiron/center-for-computational-quantum-physics/
:class: img

.. image:: _static/logo_cdf.png
:width: 4.7%
:target: https://www.college-de-france.fr
:class: img

.. image:: _static/logo_cea.png
:width: 14%
:width: 7.7%
:target: http://ipht.cea.fr
:class: img

.. image:: _static/logo_x.png
:width: 14%
:width: 4.6%
:target: "https://www.cpht.polytechnique.fr
:class: img

.. image:: _static/logo_cnrs.png
:width: 14%
:width: 6.3%
:target: https://www.cnrs.fr
:class: img

.. image:: _static/logo_erc.jpg
:width: 14%

.. image:: _static/logo_flatiron.png
:width: 20%
:target: https://www.simonsfoundation.org/flatiron

.. image:: _static/logo_simons.jpg
:width: 20%
:target: https://www.simonsfoundation.org
:width: 6.6%
Binary file added triqs/3.3.x/_static/logo_ccq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added triqs/3.3.x/_static/logo_cdf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed triqs/3.3.x/_static/logo_flatiron.png
Binary file not shown.
Binary file removed triqs/3.3.x/_static/logo_simons.jpg
Binary file not shown.
Binary file added triqs/3.3.x/_static/logo_simons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d06a263

Please sign in to comment.