Skip to content

Commit 0dd2f68

Browse files
author
Documenter.jl
committed
build based on 2a89b3d
1 parent 567902a commit 0dd2f68

19 files changed

Lines changed: 45 additions & 51 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-20T08:10:19","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-20T12:45:46","julia_version":"1.12.6"}}

previews/PR106/api/index.html

Lines changed: 15 additions & 15 deletions
Large diffs are not rendered by default.

previews/PR106/band-symmetry/index.html

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@
2424
TRIVIAL::TopologyKind = 0</code></pre><p>I.e., in this example, both band representations are either a trivial or a fragile phase. To resolve this distinction, we can use <a href="https://github.com/thchr/SymmetryBases.jl">SymmetryBases.jl</a>&#39;s <code>calc_detailed_topology</code>:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using SymmetryBases</code><code class="nohighlight hljs ansi" style="display:block;"><span class="sgr32"><span class="sgr1"> CondaPkg </span></span>Found dependencies: /home/runner/.julia/packages/CondaPkg/8GjrP/CondaPkg.toml
2525
<span class="sgr32"><span class="sgr1"> CondaPkg </span></span>Found dependencies: /home/runner/.julia/packages/PythonCall/83z4q/CondaPkg.toml
2626
<span class="sgr32"><span class="sgr1"> CondaPkg </span></span>Found dependencies: /home/runner/.julia/packages/SymmetryBases/dd17j/CondaPkg.toml
27-
<span class="sgr32"><span class="sgr1"> CondaPkg </span></span>Resolving changes
28-
<span class="sgr32"><span class="sgr1"> </span>+ libstdcxx</span>
29-
<span class="sgr32"><span class="sgr1"> </span>+ libstdcxx-ng</span>
30-
<span class="sgr32"><span class="sgr1"> </span>+ openssl</span>
31-
<span class="sgr32"><span class="sgr1"> </span>+ pynormaliz</span>
32-
<span class="sgr32"><span class="sgr1"> </span>+ python</span>
3327
<span class="sgr32"><span class="sgr1"> CondaPkg </span></span>Initialising pixi
3428
<span class="sgr32"><span class="sgr1"> </span></span><span class="sgr90">/home/runner/.julia/artifacts/cefba4912c2b400756d043a2563ef77a0088866b/bin/pixi</span>
3529
<span class="sgr32"><span class="sgr1"> </span></span><span class="sgr90">init</span>
@@ -60,4 +54,4 @@
6054
<span class="sgr32"><span class="sgr1"> </span></span><span class="sgr90">--manifest-path /home/runner/work/SymmetricTightBinding.jl/SymmetricTightBinding.jl/docs/.CondaPkg/pixi.toml</span>
6155
✔ The default environment has been installed.</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; calc_detailed_topology.(ns, Ref(brs))</code><code class="nohighlight hljs ansi" style="display:block;">2-element Vector{Crystalline.TopologyKind}:
6256
TRIVIAL::TopologyKind = 0
63-
FRAGILE::TopologyKind = 2</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</a><a class="docs-footer-nextpage" href="../berry/">Berry curvature &amp; Chern numbers »</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.17.0 on <span class="colophon-date" title="Monday 20 April 2026 08:10">Monday 20 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
57+
FRAGILE::TopologyKind = 2</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</a><a class="docs-footer-nextpage" href="../berry/">Berry curvature &amp; Chern numbers »</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.17.0 on <span class="colophon-date" title="Monday 20 April 2026 12:45">Monday 20 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

previews/PR106/berry/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<span class="sgr90"></span>⎢ ──────────────────────────┼────────────────────── ⎥
5353
<span class="sgr90"></span><span class="sgr34">-i𝕖(-δ₁)-i𝕖(-δ₂)-i𝕖(-δ₃)</span><span class="sgr90">0</span>
5454
<span class="sgr90">└─ </span><span class="sgr34">(1b|A)</span><span class="sgr34">(1c|A)</span><span class="sgr90">: δ₁=[1/3,-1/3], δ₂=[1/3,2/3], δ₃=[-2/3,-1/3]</span></code></pre><p>The terms in <code>tbm</code> form a basis for many possible Hamiltonians, including for the Haldane model. By comparing term by term with Haldane&#39;s expressions, the correct parameterization can be determined to be:</p><pre><code class="language-julia hljs">haldane_model(t₁, m, t₂, ϕ) = tbm([m, t₂*cos(ϕ), t₂*sin(ϕ), -m, t₂*cos(ϕ), -t₂*sin(ϕ), t₁, 0])</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">haldane_model (generic function with 1 method)</code></pre><p>This realizes the Haldane Hamiltonian with nearest-neighbor hopping <span>$t_1$</span>, a staggered mass term <span>$m$</span>, and a complex next-nearest-neighbor hopping <span>$t_2 \exp(\pm\mathrm{i}\phi)$</span> with Haldane&#39;s zero-flux pattern. The model is gapless for <span>$m/t_2 = 3\sqrt{3}|\sin\phi|$</span> and otherwise gapped when <span>$|t_2 / t_1| &lt; 1/3$</span>.</p><p>The Berry curvature is nonzero at generic <strong>k</strong>-points and generic values of <code>t₁, m, t₂, ϕ</code>, as we can verify with the <a href="../api/#SymmetricTightBinding.berrycurvature-Union{Tuple{D}, Tuple{ParameterizedTightBindingModel{D}, Union{NTuple{D, var&quot;#s36&quot;} where var&quot;#s36&quot;&lt;:Real, AbstractVector{&lt;:Real}}, Integer}, Tuple{ParameterizedTightBindingModel{D}, Union{NTuple{D, var&quot;#s36&quot;} where var&quot;#s36&quot;&lt;:Real, AbstractVector{&lt;:Real}}, Integer, NTuple{D, Matrix{ComplexF64}}}} where D"><code>berrycurvature</code></a> method:</p><pre><code class="language-julia hljs">ptbm = haldane_model(1.0, 0.1, 0.1, π/2)
55-
berrycurvature(ptbm, [.2, .3], 1)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">6.155322378740026</code></pre><p>We can use this to e.g., visualize the Berry curvature distribution over the Brillouin zone:</p><pre><code class="language-julia hljs"># compute the Berry curvature over the parallelipiped Brillouin zone
55+
berrycurvature(ptbm, [.2, .3], 1)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">6.155322378740029</code></pre><p>We can use this to e.g., visualize the Berry curvature distribution over the Brillouin zone:</p><pre><code class="language-julia hljs"># compute the Berry curvature over the parallelipiped Brillouin zone
5656
Gs = dualbasis(directbasis(sgnum, Val(2)))
5757
ks = range(-0.5, 0.5, 100) # k-points&#39; range in reciprocal basis coordinates
5858
k12s = (ReciprocalPoint(k1, k2) for k1 in ks, k2 in ks)
@@ -110,7 +110,7 @@
110110
cb.ticks = -1:1
111111
cb.label = &quot;Chern number&quot;
112112

113-
f</code></pre><img src="71085a70.png" alt="Example block output"/><p>We could also have obtained a similar-looking phase diagram by using topological quantum chemistry:</p><pre><code class="language-julia hljs">νs = Matrix{Int}(undef, N, N)
113+
f</code></pre><img src="051e7591.png" alt="Example block output"/><p>We could also have obtained a similar-looking phase diagram by using topological quantum chemistry:</p><pre><code class="language-julia hljs">νs = Matrix{Int}(undef, N, N)
114114
F = smith(stack(brs)) # Smith decomposition of `brs`; precomputed for efficiency
115115
for (i, ϕ) in enumerate(ϕs), (j, Mdivt2) in enumerate(Mdivt2s)
116116
ptbm = haldane_model(Mdivt2, ϕ)
@@ -142,4 +142,4 @@
142142
Φ = sum(berrycurvature(ptbm, [k1, k2, k3], 1)[3] for k1 in k12s, k2 in k12s; init=0.0) / Nk^2
143143

144144
# normalize by 2π to obtain associated Chern number
145-
C₃ = Φ / (2π)</code></pre></div></div><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>F.D.M. Haldane, <em>Model for a Quantum Hall Effect without Landau Levels: Condensed-Matter Realization of the &quot;Parity Anomaly&quot;</em>, <a href="https://doi.org/10.1103/PhysRevLett.61.2015">Phys. Rev. Lett. <strong>61</strong>, 2015 (1988)</a>.</li><li class="footnote" id="footnote-2"><a class="tag is-link" href="#citeref-2">2</a>While it is natural to think of the Haldane model as associated with 6-fold symmetry and a graphene-like model, and hence with plane groups <em>p</em>6 or <em>p</em>6mm, the presence of the staggered mass term reduces the model&#39;s symmetry to <em>p</em>3. Thus, the orbitals do not associate with the 2b Wyckoff position of <em>p</em>6(mm), as is usually the case for graphene-like models, but with the two distinct Wyckoff positions that the <em>p</em>6(mm) 2b Wyckoff position subduces to when inversion symmetry is broken: this is precisely the 2b and 2c positions in <em>p</em>3.</li><li class="footnote" id="footnote-3"><a class="tag is-link" href="#citeref-3">3</a>Fukui, Hatsugai, &amp; Suzuki, <em>Chern Numbers in Discretized Brillouin Zone: Efficient Method of Computing (Spin) Hall Conductances</em>, <a href="https://doi.org/10.1143/JPSJ.74.1674">J. Phys. Soc. Jpn. <strong>74</strong>, 1674 (2005)</a>.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../band-symmetry/">« Band symmetry</a><a class="docs-footer-nextpage" href="../symmetry-breaking/">Symmetry breaking »</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.17.0 on <span class="colophon-date" title="Monday 20 April 2026 08:10">Monday 20 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
145+
C₃ = Φ / (2π)</code></pre></div></div><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>F.D.M. Haldane, <em>Model for a Quantum Hall Effect without Landau Levels: Condensed-Matter Realization of the &quot;Parity Anomaly&quot;</em>, <a href="https://doi.org/10.1103/PhysRevLett.61.2015">Phys. Rev. Lett. <strong>61</strong>, 2015 (1988)</a>.</li><li class="footnote" id="footnote-2"><a class="tag is-link" href="#citeref-2">2</a>While it is natural to think of the Haldane model as associated with 6-fold symmetry and a graphene-like model, and hence with plane groups <em>p</em>6 or <em>p</em>6mm, the presence of the staggered mass term reduces the model&#39;s symmetry to <em>p</em>3. Thus, the orbitals do not associate with the 2b Wyckoff position of <em>p</em>6(mm), as is usually the case for graphene-like models, but with the two distinct Wyckoff positions that the <em>p</em>6(mm) 2b Wyckoff position subduces to when inversion symmetry is broken: this is precisely the 2b and 2c positions in <em>p</em>3.</li><li class="footnote" id="footnote-3"><a class="tag is-link" href="#citeref-3">3</a>Fukui, Hatsugai, &amp; Suzuki, <em>Chern Numbers in Discretized Brillouin Zone: Efficient Method of Computing (Spin) Hall Conductances</em>, <a href="https://doi.org/10.1143/JPSJ.74.1674">J. Phys. Soc. Jpn. <strong>74</strong>, 1674 (2005)</a>.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../band-symmetry/">« Band symmetry</a><a class="docs-footer-nextpage" href="../symmetry-breaking/">Symmetry breaking »</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.17.0 on <span class="colophon-date" title="Monday 20 April 2026 12:45">Monday 20 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)