Skip to content

Commit

Permalink
Generated documentation for triqs/3.1.x
Browse files Browse the repository at this point in the history
jenkins-TRIQS-triqs-3.1.x-178 a0f77298c9166a422fef8c8f9a3278b30efa113d
  • Loading branch information
flatiron-jenkins committed Apr 3, 2024
1 parent 6765400 commit 235b7cb
Show file tree
Hide file tree
Showing 14 changed files with 49 additions and 49 deletions.
44 changes: 22 additions & 22 deletions triqs/3.1.x/_modules/triqs/gf/gf.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion triqs/3.1.x/_modules/triqs/lattice/tight_binding.html
Original file line number Diff line number Diff line change
Expand Up @@ -1441,7 +1441,7 @@ <h1>Source code for triqs.lattice.tight_binding</h1><div class="highlight"><pre>


<div class="viewcode-block" id="dos">
<a class="viewcode-back" href="../../../documentation/manual/triqs/lattice_tools/dos.html#triqs.lattice.tight_binding.dos">[docs]</a>
<a class="viewcode-back" href="../../../documentation/python_api/triqs.lattice.tight_binding.dos.html#triqs.lattice.tight_binding.dos">[docs]</a>
<span class="k">def</span> <span class="nf">dos</span><span class="p">(</span><span class="n">tight_binding</span><span class="p">,</span> <span class="n">n_kpts</span><span class="p">,</span> <span class="n">n_eps</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> :param tight_binding: a tight_binding object</span>
Expand Down
10 changes: 5 additions & 5 deletions triqs/3.1.x/_modules/triqs/operators/util/hamiltonians.html
Original file line number Diff line number Diff line change
Expand Up @@ -1433,7 +1433,7 @@ <h1>Source code for triqs.operators.util.hamiltonians</h1><div class="highlight"
<span class="c1"># Define commonly-used Hamiltonians here: Slater, Kanamori, density-density</span>

<div class="viewcode-block" id="h_int_slater">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/hamiltonians.html#triqs.operators.util.hamiltonians.h_int_slater">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.hamiltonians.h_int_slater.html#triqs.operators.util.hamiltonians.h_int_slater">[docs]</a>
<span class="k">def</span> <span class="nf">h_int_slater</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span><span class="n">orb_names</span><span class="p">,</span><span class="n">U_matrix</span><span class="p">,</span><span class="n">off_diag</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="n">map_operator_structure</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="n">H_dump</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="nb">complex</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Create a Slater Hamiltonian using fully rotationally-invariant 4-index interactions:</span>
Expand Down Expand Up @@ -1496,7 +1496,7 @@ <h1>Source code for triqs.operators.util.hamiltonians</h1><div class="highlight"


<div class="viewcode-block" id="h_int_kanamori">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/hamiltonians.html#triqs.operators.util.hamiltonians.h_int_kanamori">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.hamiltonians.h_int_kanamori.html#triqs.operators.util.hamiltonians.h_int_kanamori">[docs]</a>
<span class="k">def</span> <span class="nf">h_int_kanamori</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span><span class="n">orb_names</span><span class="p">,</span><span class="n">U</span><span class="p">,</span><span class="n">Uprime</span><span class="p">,</span><span class="n">J_hund</span><span class="p">,</span><span class="n">off_diag</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="n">map_operator_structure</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="n">H_dump</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>
<span class="sd"> Create a Kanamori Hamiltonian using the density-density, spin-fip and pair-hopping interactions.</span>
Expand Down Expand Up @@ -1599,7 +1599,7 @@ <h1>Source code for triqs.operators.util.hamiltonians</h1><div class="highlight"


<div class="viewcode-block" id="h_int_density">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/hamiltonians.html#triqs.operators.util.hamiltonians.h_int_density">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.hamiltonians.h_int_density.html#triqs.operators.util.hamiltonians.h_int_density">[docs]</a>
<span class="k">def</span> <span class="nf">h_int_density</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span><span class="n">orb_names</span><span class="p">,</span><span class="n">U</span><span class="p">,</span><span class="n">Uprime</span><span class="p">,</span><span class="n">off_diag</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="n">map_operator_structure</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span><span class="n">H_dump</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>
<span class="sd"> Create a density-density Hamiltonian.</span>
Expand Down Expand Up @@ -1662,7 +1662,7 @@ <h1>Source code for triqs.operators.util.hamiltonians</h1><div class="highlight"


<div class="viewcode-block" id="diagonal_part">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/hamiltonians.html#triqs.operators.util.hamiltonians.diagonal_part">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.hamiltonians.diagonal_part.html#triqs.operators.util.hamiltonians.diagonal_part">[docs]</a>
<span class="k">def</span> <span class="nf">diagonal_part</span><span class="p">(</span><span class="n">H</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Extract the density part from an operator H.</span>
Expand Down Expand Up @@ -1693,7 +1693,7 @@ <h1>Source code for triqs.operators.util.hamiltonians</h1><div class="highlight"


<div class="viewcode-block" id="make_operator_real">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/hamiltonians.html#triqs.operators.util.hamiltonians.make_operator_real">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.hamiltonians.make_operator_real.html#triqs.operators.util.hamiltonians.make_operator_real">[docs]</a>
<span class="k">def</span> <span class="nf">make_operator_real</span><span class="p">(</span><span class="n">H</span><span class="p">,</span> <span class="n">tol</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the real part of a given operator H checking that its</span>
Expand Down
12 changes: 6 additions & 6 deletions triqs/3.1.x/_modules/triqs/operators/util/observables.html
Original file line number Diff line number Diff line change
Expand Up @@ -1437,7 +1437,7 @@ <h1>Source code for triqs.operators.util.observables</h1><div class="highlight">
<span class="s1">&#39;-&#39;</span> <span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([[</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">],[</span><span class="mi">2</span><span class="p">,</span><span class="mi">0</span><span class="p">]])}</span>

<div class="viewcode-block" id="N_op">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/observables.html#triqs.operators.util.observables.N_op">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.observables.N_op.html#triqs.operators.util.observables.N_op">[docs]</a>
<span class="k">def</span> <span class="nf">N_op</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span> <span class="n">orb_names</span><span class="p">,</span> <span class="n">off_diag</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">map_operator_structure</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>
<span class="sd"> Create an operator of the total number of particles.</span>
Expand Down Expand Up @@ -1472,7 +1472,7 @@ <h1>Source code for triqs.operators.util.observables</h1><div class="highlight">


<div class="viewcode-block" id="S_op">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/observables.html#triqs.operators.util.observables.S_op">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.observables.S_op.html#triqs.operators.util.observables.S_op">[docs]</a>
<span class="k">def</span> <span class="nf">S_op</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="n">spin_names</span><span class="p">,</span> <span class="n">orb_names</span><span class="p">,</span> <span class="n">off_diag</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">map_operator_structure</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>
<span class="sd"> Create a component of the spin vector operator.</span>
Expand Down Expand Up @@ -1516,7 +1516,7 @@ <h1>Source code for triqs.operators.util.observables</h1><div class="highlight">


<div class="viewcode-block" id="S2_op">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/observables.html#triqs.operators.util.observables.S2_op">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.observables.S2_op.html#triqs.operators.util.observables.S2_op">[docs]</a>
<span class="k">def</span> <span class="nf">S2_op</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span> <span class="n">orb_names</span><span class="p">,</span> <span class="n">off_diag</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">map_operator_structure</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>
<span class="sd"> Create the square of the total spin operator.</span>
Expand Down Expand Up @@ -1549,7 +1549,7 @@ <h1>Source code for triqs.operators.util.observables</h1><div class="highlight">


<div class="viewcode-block" id="L_op">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/observables.html#triqs.operators.util.observables.L_op">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.observables.L_op.html#triqs.operators.util.observables.L_op">[docs]</a>
<span class="k">def</span> <span class="nf">L_op</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="n">spin_names</span><span class="p">,</span> <span class="n">orb_names</span><span class="p">,</span> <span class="n">off_diag</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">map_operator_structure</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">basis</span><span class="o">=</span><span class="s1">&#39;spherical&#39;</span><span class="p">,</span> <span class="n">T</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>
<span class="sd"> Create a component of the orbital momentum vector operator.</span>
Expand Down Expand Up @@ -1622,7 +1622,7 @@ <h1>Source code for triqs.operators.util.observables</h1><div class="highlight">


<div class="viewcode-block" id="L2_op">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/observables.html#triqs.operators.util.observables.L2_op">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.observables.L2_op.html#triqs.operators.util.observables.L2_op">[docs]</a>
<span class="k">def</span> <span class="nf">L2_op</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span> <span class="n">orb_names</span><span class="p">,</span> <span class="n">off_diag</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">map_operator_structure</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">basis</span><span class="o">=</span><span class="s1">&#39;spherical&#39;</span><span class="p">,</span> <span class="n">T</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>
<span class="sd"> Create the square of the orbital momentum operator.</span>
Expand Down Expand Up @@ -1665,7 +1665,7 @@ <h1>Source code for triqs.operators.util.observables</h1><div class="highlight">


<div class="viewcode-block" id="LS_op">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/observables.html#triqs.operators.util.observables.LS_op">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.observables.LS_op.html#triqs.operators.util.observables.LS_op">[docs]</a>
<span class="k">def</span> <span class="nf">LS_op</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span> <span class="n">orb_names</span><span class="p">,</span> <span class="n">off_diag</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">map_operator_structure</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">basis</span><span class="o">=</span><span class="s1">&#39;spherical&#39;</span><span class="p">,</span> <span class="n">T</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>
<span class="sd"> Create a spin-orbital coupling operator.</span>
Expand Down
4 changes: 2 additions & 2 deletions triqs/3.1.x/_modules/triqs/operators/util/op_struct.html
Original file line number Diff line number Diff line change
Expand Up @@ -1427,7 +1427,7 @@ <h1>Source code for triqs.operators.util.op_struct</h1><div class="highlight"><p

<span class="c1"># Set function to make index for GF blocks given spin sn and orbital name on</span>
<div class="viewcode-block" id="get_mkind">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/op_struct.html#triqs.operators.util.op_struct.get_mkind">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.op_struct.get_mkind.html#triqs.operators.util.op_struct.get_mkind">[docs]</a>
<span class="k">def</span> <span class="nf">get_mkind</span><span class="p">(</span><span class="n">off_diag</span><span class="p">,</span><span class="n">map_operator_structure</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set function that makes the index for operators and GF blocks for a given</span>
Expand Down Expand Up @@ -1466,7 +1466,7 @@ <h1>Source code for triqs.operators.util.op_struct</h1><div class="highlight"><p

<span class="c1"># Set block structure of GF</span>
<div class="viewcode-block" id="set_operator_structure">
<a class="viewcode-back" href="../../../../documentation/manual/triqs/operators/util/op_struct.html#triqs.operators.util.op_struct.set_operator_structure">[docs]</a>
<a class="viewcode-back" href="../../../../documentation/python_api/triqs.operators.util.op_struct.set_operator_structure.html#triqs.operators.util.op_struct.set_operator_structure">[docs]</a>
<span class="k">def</span> <span class="nf">set_operator_structure</span><span class="p">(</span><span class="n">spin_names</span><span class="p">,</span><span class="n">n_orb</span><span class="p">,</span><span class="n">off_diag</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set the operator_structure for given spin and orbital names, according to</span>
Expand Down
Loading

0 comments on commit 235b7cb

Please sign in to comment.