build based on 8a8b193

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-28T16:36:29","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-05T17:42:08","documenter_version":"1.8.0"}}

dev/advanced/meanfield/index.html

@@ -81,4 +81,4 @@
  0.15596283661234628 + 0.0im
  0.34403716338765444 + 0.0im
  0.34403716338765344 + 0.0im
- 0.15596283661234572 + 0.0im</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../serializers/">« Serializers</a><a class="docs-footer-nextpage" href="../wannier90/">Wannier90 imports »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 28 November 2024 16:36">Thursday 28 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 0.15596283661234572 + 0.0im</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../serializers/">« Serializers</a><a class="docs-footer-nextpage" href="../wannier90/">Wannier90 imports »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 17:42">Thursday 5 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/advanced/nonspatial/index.html

@@ -49,4 +49,4 @@
  2.1382+0.0im    -1.0+0.0im         ⋅             ⋅
    -1.0+0.0im  2.3618+0.0im    -1.0+0.0im         ⋅
         ⋅        -1.0+0.0im  2.3618+0.0im    -1.0+0.0im
-        ⋅             ⋅        -1.0+0.0im  2.1382+0.0im</code></pre><p>Note the <code>ρ[i]</code> above. This indexes <code>ρ</code> at site <code>i</code>. For a multiorbital hamiltonian, this will be a matrix (the local density matrix on each site <code>i</code>). Here it is just a number, either <code>0.138197</code> (sites 1 and 4) or <code>0.361803</code> (sites 2 and 3).</p><div class="admonition is-success"><header class="admonition-header">Sparse vs dense</header><div class="admonition-body"><p>The method explained above to build a Hamiltonian <code>hρ</code> using <code>--&gt;</code> supports all the <code>SiteSelector</code> and <code>HopSelector</code> functionality of conventional models. Therefore, although the density matrix computed above is dense, its application to the Hamiltonian is sparse: it only touches the onsite matrix elements in this case.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorial/observables/">« Observables</a><a class="docs-footer-nextpage" href="../serializers/">Serializers »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 28 November 2024 16:36">Thursday 28 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+        ⋅             ⋅        -1.0+0.0im  2.1382+0.0im</code></pre><p>Note the <code>ρ[i]</code> above. This indexes <code>ρ</code> at site <code>i</code>. For a multiorbital hamiltonian, this will be a matrix (the local density matrix on each site <code>i</code>). Here it is just a number, either <code>0.138197</code> (sites 1 and 4) or <code>0.361803</code> (sites 2 and 3).</p><div class="admonition is-success"><header class="admonition-header">Sparse vs dense</header><div class="admonition-body"><p>The method explained above to build a Hamiltonian <code>hρ</code> using <code>--&gt;</code> supports all the <code>SiteSelector</code> and <code>HopSelector</code> functionality of conventional models. Therefore, although the density matrix computed above is dense, its application to the Hamiltonian is sparse: it only touches the onsite matrix elements in this case.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorial/observables/">« Observables</a><a class="docs-footer-nextpage" href="../serializers/">Serializers »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 17:42">Thursday 5 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/advanced/serializers/index.html

@@ -44,4 +44,4 @@
 true
 
 julia> @btime deserialize!($as, serialize!($v, $as));
-  149.737 ns (0 allocations: 0 bytes)</code></pre><p>It also allows powerful compression into relevant degrees of freedom through appropriate use of encoders/decoders, see the <code>serializer</code> docstring.</p><h2 id="Serializers-of-OrbitalSliceArrays"><a class="docs-heading-anchor" href="#Serializers-of-OrbitalSliceArrays">Serializers of OrbitalSliceArrays</a><a id="Serializers-of-OrbitalSliceArrays-1"></a><a class="docs-heading-anchor-permalink" href="#Serializers-of-OrbitalSliceArrays" title="Permalink"></a></h2><p>Serialization of <code>OrbitalSliceArray</code>s is simpler than for <code>AbstractHamiltonians</code>, as there is no need for an intermediate <code>Serializer</code> object. To serialize an <code>m::OrbitalSliceArray</code> simply do <code>v = serialize(m)</code>. To deserialize, just do <code>m´ = deserialize(m, v)</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../nonspatial/">« Non-spatial models</a><a class="docs-footer-nextpage" href="../meanfield/">Self-consistent mean fields »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 28 November 2024 16:36">Thursday 28 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  149.737 ns (0 allocations: 0 bytes)</code></pre><p>It also allows powerful compression into relevant degrees of freedom through appropriate use of encoders/decoders, see the <code>serializer</code> docstring.</p><h2 id="Serializers-of-OrbitalSliceArrays"><a class="docs-heading-anchor" href="#Serializers-of-OrbitalSliceArrays">Serializers of OrbitalSliceArrays</a><a id="Serializers-of-OrbitalSliceArrays-1"></a><a class="docs-heading-anchor-permalink" href="#Serializers-of-OrbitalSliceArrays" title="Permalink"></a></h2><p>Serialization of <code>OrbitalSliceArray</code>s is simpler than for <code>AbstractHamiltonians</code>, as there is no need for an intermediate <code>Serializer</code> object. To serialize an <code>m::OrbitalSliceArray</code> simply do <code>v = serialize(m)</code>. To deserialize, just do <code>m´ = deserialize(m, v)</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../nonspatial/">« Non-spatial models</a><a class="docs-footer-nextpage" href="../meanfield/">Self-consistent mean fields »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 17:42">Thursday 5 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/advanced/wannier90/index.html

@@ -57,4 +57,4 @@
 WannierBuilder{Float64,2} : 2-dimensional Hamiltonian builder of type Float64 from Wannier90 input
   cells      : 151
   elements   : 7560
-  modifiers  : 2</code></pre><p>An interesting application of modifiers is the addition of an electric field that couples to the full <code>r</code> operator. In an strict tight-binding limit, we would add an electric field <code>E</code> simply as an onsite potential</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, r; E = SA[0,0]) -&gt; o + E&#39;*r);</code></pre><p>However, we actually have the full <code>r</code> operator now, which includes non-diagonal matrix elements. We can then incorporate the electric field term <code>E&#39;*r</code> more precisely. We can do so using the <code>--&gt;</code> syntax and the indexing functionality of the <code>r::BarebonesOperator</code> that we obtained from Wannier90</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, i; E = SA[0,0]) --&gt; o + E&#39;*r[i,i]) |&gt; @hopping!((t, i, j; E = SA[0,0]) --&gt; t + E&#39;*r[i,j]);</code></pre><div class="admonition is-info"><header class="admonition-header">Closures over non-constant objects</header><div class="admonition-body"><p>Note that the above creates a closure over <code>r</code>, which is not <code>const</code>. As a result this would incur a small performance and allocation cost when evaluating <code>hE(E=...)</code>. We can avoid it e.g. by defining <code>r</code> as a constant, <code>const r = sites(w)</code>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../meanfield/">« Self-consistent mean fields</a><a class="docs-footer-nextpage" href="../../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 28 November 2024 16:36">Thursday 28 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  modifiers  : 2</code></pre><p>An interesting application of modifiers is the addition of an electric field that couples to the full <code>r</code> operator. In an strict tight-binding limit, we would add an electric field <code>E</code> simply as an onsite potential</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, r; E = SA[0,0]) -&gt; o + E&#39;*r);</code></pre><p>However, we actually have the full <code>r</code> operator now, which includes non-diagonal matrix elements. We can then incorporate the electric field term <code>E&#39;*r</code> more precisely. We can do so using the <code>--&gt;</code> syntax and the indexing functionality of the <code>r::BarebonesOperator</code> that we obtained from Wannier90</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, i; E = SA[0,0]) --&gt; o + E&#39;*r[i,i]) |&gt; @hopping!((t, i, j; E = SA[0,0]) --&gt; t + E&#39;*r[i,j]);</code></pre><div class="admonition is-info"><header class="admonition-header">Closures over non-constant objects</header><div class="admonition-body"><p>Note that the above creates a closure over <code>r</code>, which is not <code>const</code>. As a result this would incur a small performance and allocation cost when evaluating <code>hE(E=...)</code>. We can avoid it e.g. by defining <code>r</code> as a constant, <code>const r = sites(w)</code>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../meanfield/">« Self-consistent mean fields</a><a class="docs-footer-nextpage" href="../../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Thursday 5 December 2024 17:42">Thursday 5 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>