build based on 788f9e1

previews/PR318/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-19T00:43:53","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-20T16:09:11","documenter_version":"1.7.0"}}

previews/PR318/assets/notebooks/01_LSWT_CoRh2O4.ipynb

@@ -50,16 +50,16 @@
   {
    "cell_type": "markdown",
    "source": [
-    "### Units"
+    "### Units system"
    ],
    "metadata": {}
   },
   {
    "cell_type": "markdown",
    "source": [
-    "The `Units` object selects reference energy and length\n",
-    "scales, and uses these to provide physical constants. For example, `units.K`\n",
-    "returns one kelvin as 0.086 meV, where the Boltzmann constant is implicit."
+    "The `Units` object selects reference energy and length scales,\n",
+    "and uses these to provide physical constants. For example, `units.K` returns\n",
+    "one kelvin as 0.086 meV, where the Boltzmann constant is implicit."
    ],
    "metadata": {}
   },

previews/PR318/assets/notebooks/09_Disorder_KPM.ipynb

@@ -46,7 +46,7 @@
     "\n",
     "randomize_spins!(sys)\n",
     "minimize_energy!(sys)\n",
-    "plot_spins(sys; color=[s[3] for s in sys.dipoles], ndims=2)"
+    "plot_spins(sys; color=[S[3] for S in sys.dipoles], ndims=2)"
    ],
    "metadata": {},
    "execution_count": null
@@ -129,7 +129,7 @@
     "end\n",
     "\n",
     "minimize_energy!(sys_inhom, maxiters=5_000)\n",
-    "plot_spins(sys_inhom; color=[s[3] for s in sys_inhom.dipoles], ndims=2)"
+    "plot_spins(sys_inhom; color=[S[3] for S in sys_inhom.dipoles], ndims=2)"
    ],
    "metadata": {},
    "execution_count": null

previews/PR318/assets/scripts/09_Disorder_KPM.jl

@@ -7,7 +7,7 @@ set_exchange!(sys, +1.0, Bond(1, 1, [1,0,0]))
 
 randomize_spins!(sys)
 minimize_energy!(sys)
-plot_spins(sys; color=[s[3] for s in sys.dipoles], ndims=2)
+plot_spins(sys; color=[S[3] for S in sys.dipoles], ndims=2)
 
 qs = [[0, 0, 0], [1/3, 1/3, 0], [1/2, 0, 0], [0, 0, 0]]
 labels = ["Γ", "K", "M", "Γ"]
@@ -27,7 +27,7 @@ for (site1, site2, offset) in symmetry_equivalent_bonds(sys_inhom, Bond(1,1,[1,0
 end
 
 minimize_energy!(sys_inhom, maxiters=5_000)
-plot_spins(sys_inhom; color=[s[3] for s in sys_inhom.dipoles], ndims=2)
+plot_spins(sys_inhom; color=[S[3] for S in sys_inhom.dipoles], ndims=2)
 
 swt = SpinWaveTheoryKPM(sys_inhom; measure=ssf_perp(sys_inhom), tol=0.01)
 res = intensities(swt, path; energies, kernel)

previews/PR318/examples/03_LSWT_SU3_FeI2.html

@@ -127,4 +127,4 @@
 res = domain_average(cryst, path; rotations, weights) do path_rotated
     intensities(swt, path_rotated; energies, kernel)
 end
-plot_intensities(res; units, colormap=:viridis, title=&quot;Domain Averaged Intensities&quot;)</code></pre><img src="03_LSWT_SU3_FeI2-d3f7d87e.png" alt="Example block output"/><p>This result can be directly compared to experimental neutron scattering data from <a href="https://doi.org/10.1038/s41567-020-01110-1">Bai et al.</a></p><img src="https://raw.githubusercontent.com/SunnySuite/Sunny.jl/main/docs/src/assets/FeI2_intensity.jpg"><p>(The publication figure used a non-standard coordinate system to label the wave vectors.)</p><p>To get this agreement, the theory of SU(3) coherent states is essential. The lower band has large quadrupolar character, and arises from the strong easy-axis anisotropy of FeI₂.</p><p>An interesting exercise is to repeat the same study, but using <code>:dipole</code> mode instead of <code>:SUN</code>. That alternative choice would constrain the coherent state dynamics to the space of dipoles only, and the flat band of single-ion bound states would be missing.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="02_LLD_CoRh2O4.html">« 2. Landau-Lifshitz dynamics of CoRh₂O₄ at finite <em>T</em></a><a class="docs-footer-nextpage" href="04_GSD_FeI2.html">4. Generalized spin dynamics of FeI₂ at finite <em>T</em> »</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.7.0 on <span class="colophon-date" title="Thursday 19 September 2024 00:43">Thursday 19 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+plot_intensities(res; units, colormap=:viridis, title=&quot;Domain Averaged Intensities&quot;)</code></pre><img src="03_LSWT_SU3_FeI2-d3f7d87e.png" alt="Example block output"/><p>This result can be directly compared to experimental neutron scattering data from <a href="https://doi.org/10.1038/s41567-020-01110-1">Bai et al.</a></p><img src="https://raw.githubusercontent.com/SunnySuite/Sunny.jl/main/docs/src/assets/FeI2_intensity.jpg"><p>(The publication figure used a non-standard coordinate system to label the wave vectors.)</p><p>To get this agreement, the theory of SU(3) coherent states is essential. The lower band has large quadrupolar character, and arises from the strong easy-axis anisotropy of FeI₂.</p><p>An interesting exercise is to repeat the same study, but using <code>:dipole</code> mode instead of <code>:SUN</code>. That alternative choice would constrain the coherent state dynamics to the space of dipoles only, and the flat band of single-ion bound states would be missing.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="02_LLD_CoRh2O4.html">« 2. Landau-Lifshitz dynamics of CoRh₂O₄ at finite <em>T</em></a><a class="docs-footer-nextpage" href="04_GSD_FeI2.html">4. Generalized spin dynamics of FeI₂ at finite <em>T</em> »</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.7.0 on <span class="colophon-date" title="Friday 20 September 2024 16:09">Friday 20 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>