build based on 7da2037

SunnySuite · Aug 16, 2023 · e472b63 · e472b63
1 parent f3e08fa
commit e472b63
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 72 deletions.
diff --git a/dev/examples/fei2_classical/index.html b/dev/examples/fei2_classical/index.html
diff --git a/dev/examples/fei2_tutorial/index.html b/dev/examples/fei2_tutorial/index.html
diff --git a/dev/examples/ising2d/index.html b/dev/examples/ising2d/index.html
diff --git a/dev/examples/out_of_equilibrium/index.html b/dev/examples/out_of_equilibrium/index.html
diff --git a/dev/examples/powder_averaging/index.html b/dev/examples/powder_averaging/index.html
diff --git a/dev/index.html b/dev/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Overview · Sunny documentation</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.png" alt="Sunny documentation logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>Sunny documentation</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Overview</a></li><li><a class="tocitem" href="quick-start/">Quick Start</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="examples/fei2_tutorial/">Case Study: FeI<span>$_{2}$</span></a></li><li><a class="tocitem" href="examples/out_of_equilibrium/">CP<span>$^2$</span> Skyrmion Quench</a></li><li><a class="tocitem" href="examples/powder_averaging/">Powder averaged CoRh<span>$_2$</span>O<span>$_4$</span></a></li><li><a class="tocitem" href="examples/fei2_classical/">Structure Factors with Classical Dynamics</a></li><li><a class="tocitem" href="examples/ising2d/">Classical Ising model</a></li></ul></li><li><a class="tocitem" href="library/">Library API</a></li><li><a class="tocitem" href="structure-factor/">Structure Factor Calculations</a></li><li><a class="tocitem" href="writevtk/">Volumetric Rendering with ParaView</a></li><li><a class="tocitem" href="versions/">Version History</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Overview</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Overview</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/SunnySuite/Sunny.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Sunny.jl"><a class="docs-heading-anchor" href="#Sunny.jl">Sunny.jl</a><a id="Sunny.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Sunny.jl" title="Permalink"></a></h1><p><a href="https://github.com/SunnySuite/Sunny.jl/">Sunny</a> is a package for simulating classical spin systems, including the Landau-Lifshitz dynamics of spin dipoles and its generalization to multipolar spin components. The latter is especially powerful for modeling magnetic compounds with strong single-ion anisotropy interactions.</p><p>Sunny provides the following features:</p><ul><li>Generalized spin dynamics using <a href="https://arxiv.org/abs/2209.01265">SU(<em>N</em>) coherent states</a>.</li><li>Ability specify a crystal by a <code>.cif</code> file, or using its spacegroup symmetry.</li><li>Symmetry analysis to classify allowed interaction terms, and to propagate them by symmetry.</li><li>Single-ion anisotropy at arbitrary order, which can be specified using Stevens operators or as a polynomial of spin operators.</li><li>Monte Carlo sampling of spin configurations in thermal equilibrium.</li><li>Ewald summation for long-range dipole-dipole interactions, accelerated with the fast Fourier transform (FFT).</li><li>Estimation of the <span>$\mathcal{S}(\mathbf{q}, \omega)$</span> dynamical structure factor data, with options for various corrections (form factor, classical-to-quantum factors, ...)</li></ul><p>Work in progress includes:</p><ul><li>Linear spin wave theory and its generalization to SU(<em>N</em>) coherent states.</li><li>Interactive visualizations of the 3D crystals and structure factor data.</li><li>MPI-distributed Monte Carlo sampling, including <a href="https://en.wikipedia.org/wiki/Parallel_tempering">parallel tempering</a>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quick-start/">Quick Start »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 16 August 2023 04:18">Wednesday 16 August 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Overview · Sunny documentation</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.png" alt="Sunny documentation logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>Sunny documentation</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Overview</a></li><li><a class="tocitem" href="quick-start/">Quick Start</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="examples/fei2_tutorial/">Case Study: FeI<span>$_{2}$</span></a></li><li><a class="tocitem" href="examples/out_of_equilibrium/">CP<span>$^2$</span> Skyrmion Quench</a></li><li><a class="tocitem" href="examples/powder_averaging/">Powder averaged CoRh<span>$_2$</span>O<span>$_4$</span></a></li><li><a class="tocitem" href="examples/fei2_classical/">Structure Factors with Classical Dynamics</a></li><li><a class="tocitem" href="examples/ising2d/">Classical Ising model</a></li></ul></li><li><a class="tocitem" href="library/">Library API</a></li><li><a class="tocitem" href="structure-factor/">Structure Factor Calculations</a></li><li><a class="tocitem" href="writevtk/">Volumetric Rendering with ParaView</a></li><li><a class="tocitem" href="versions/">Version History</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Overview</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Overview</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/SunnySuite/Sunny.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Sunny.jl"><a class="docs-heading-anchor" href="#Sunny.jl">Sunny.jl</a><a id="Sunny.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Sunny.jl" title="Permalink"></a></h1><p><a href="https://github.com/SunnySuite/Sunny.jl/">Sunny</a> is a package for simulating classical spin systems, including the Landau-Lifshitz dynamics of spin dipoles and its generalization to multipolar spin components. The latter is especially powerful for modeling magnetic compounds with strong single-ion anisotropy interactions.</p><p>Sunny provides the following features:</p><ul><li>Generalized spin dynamics using <a href="https://arxiv.org/abs/2209.01265">SU(<em>N</em>) coherent states</a>.</li><li>Ability specify a crystal by a <code>.cif</code> file, or using its spacegroup symmetry.</li><li>Symmetry analysis to classify allowed interaction terms, and to propagate them by symmetry.</li><li>Single-ion anisotropy at arbitrary order, which can be specified using Stevens operators or as a polynomial of spin operators.</li><li>Monte Carlo sampling of spin configurations in thermal equilibrium.</li><li>Ewald summation for long-range dipole-dipole interactions, accelerated with the fast Fourier transform (FFT).</li><li>Estimation of the <span>$\mathcal{S}(\mathbf{q}, \omega)$</span> dynamical structure factor data, with options for various corrections (form factor, classical-to-quantum factors, ...)</li></ul><p>Work in progress includes:</p><ul><li>Linear spin wave theory and its generalization to SU(<em>N</em>) coherent states.</li><li>Interactive visualizations of the 3D crystals and structure factor data.</li><li>MPI-distributed Monte Carlo sampling, including <a href="https://en.wikipedia.org/wiki/Parallel_tempering">parallel tempering</a>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quick-start/">Quick Start »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 16 August 2023 15:44">Wednesday 16 August 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/library/index.html b/dev/library/index.html
diff --git a/dev/quick-start/index.html b/dev/quick-start/index.html
@@ -33,4 +33,4 @@
 Allowed exchange matrix: | A  C -D |
                          | C  A -D |
                          | D  D  B |
-Allowed DM vector: [-D D 0]</code></pre><p>Sunny reported that a single-ion anisotropy is only allowed at quartic and hexic orders, which is consistent with the cubic point group symmetry. Additionally, Sunny reported the allowed forms of nearest and next-nearest neighbor interaction.</p><p>The next steps are typically the following</p><ol><li>Build a <a href="../library/#Sunny.System-Tuple{Crystal, Tuple{Int64, Int64, Int64}, Vector{SpinInfo}, Symbol}"><code>System</code></a> which contains spins on a finite size lattice of crystal unit cells.</li><li>Add interactions to the system using functions like <a href="../library/#Sunny.set_external_field!-Tuple{System, Any}"><code>set_external_field!</code></a>, <a href="../library/#Sunny.set_exchange!-Union{Tuple{N}, Tuple{System{N}, Any, Bond}} where N"><code>set_exchange!</code></a>, and <a href="../library/#Sunny.set_onsite_coupling!-Union{Tuple{N}, Tuple{System{N}, Matrix{ComplexF64}, Int64}} where N"><code>set_onsite_coupling!</code></a>.</li><li>Perform Monte Carlo simulation to equilibrate the spin configuration. Options include the continuous <a href="../library/#Sunny.Langevin"><code>Langevin</code></a> dynamics, or single-spin flip updates with <a href="../library/#Sunny.LocalSampler"><code>LocalSampler</code></a>. The former can efficiently handle long-range dipole-dipole interactions, while the latter may be better in the presence of strong anisotropy (e.g., the Ising limit).</li><li>Measure the static or dynamical structure factor. For details, see the page <a href="../structure-factor/#Structure-Factor-Calculations">Structure Factor Calculations</a>.</li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Overview</a><a class="docs-footer-nextpage" href="../examples/fei2_tutorial/">Case Study: FeI<span>$_{2}$</span> »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 16 August 2023 04:18">Wednesday 16 August 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+Allowed DM vector: [-D D 0]</code></pre><p>Sunny reported that a single-ion anisotropy is only allowed at quartic and hexic orders, which is consistent with the cubic point group symmetry. Additionally, Sunny reported the allowed forms of nearest and next-nearest neighbor interaction.</p><p>The next steps are typically the following</p><ol><li>Build a <a href="../library/#Sunny.System-Tuple{Crystal, Tuple{Int64, Int64, Int64}, Vector{SpinInfo}, Symbol}"><code>System</code></a> which contains spins on a finite size lattice of crystal unit cells.</li><li>Add interactions to the system using functions like <a href="../library/#Sunny.set_external_field!-Tuple{System, Any}"><code>set_external_field!</code></a>, <a href="../library/#Sunny.set_exchange!-Union{Tuple{N}, Tuple{System{N}, Any, Bond}} where N"><code>set_exchange!</code></a>, and <a href="../library/#Sunny.set_onsite_coupling!-Union{Tuple{N}, Tuple{System{N}, Matrix{ComplexF64}, Int64}} where N"><code>set_onsite_coupling!</code></a>.</li><li>Perform Monte Carlo simulation to equilibrate the spin configuration. Options include the continuous <a href="../library/#Sunny.Langevin"><code>Langevin</code></a> dynamics, or single-spin flip updates with <a href="../library/#Sunny.LocalSampler"><code>LocalSampler</code></a>. The former can efficiently handle long-range dipole-dipole interactions, while the latter may be better in the presence of strong anisotropy (e.g., the Ising limit).</li><li>Measure the static or dynamical structure factor. For details, see the page <a href="../structure-factor/#Structure-Factor-Calculations">Structure Factor Calculations</a>.</li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Overview</a><a class="docs-footer-nextpage" href="../examples/fei2_tutorial/">Case Study: FeI<span>$_{2}$</span> »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 16 August 2023 15:43">Wednesday 16 August 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>