build based on 5597145

SunnySuite · Aug 23, 2023 · 7ba6b82 · 7ba6b82
1 parent bdb0be7
commit 7ba6b82
Show file tree

Hide file tree

Showing 12 changed files with 77 additions and 77 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/one_dim_chain/index.html b/dev/examples/one_dim_chain/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><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><li><a class="tocitem" href="examples/one_dim_chain/">Fitting model parameters in a 1D spin-1 ferromagnetic chain</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-Overview"><a class="docs-heading-anchor" href="#Sunny-Overview">Sunny Overview</a><a id="Sunny-Overview-1"></a><a class="docs-heading-anchor-permalink" href="#Sunny-Overview" title="Permalink"></a></h1><p><a href="https://github.com/SunnySuite/Sunny.jl/">Sunny</a> is a Julia package for modeling atomic-scale magnetism. It provides powerful tools to study equilibrium and non-equilibrium magnetic phenomena. In particular, it allows estimation of dynamical structure factor intensities, <span>$\mathcal{S}(𝐪,ω)$</span>, to support quantitative modeling of experimental scattering data.</p><p><strong>Features include</strong>:</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>Interactive visualizations of the 3D crystals and magnetic ordering.</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, and optimization tools.</li><li>Measurements of dynamical correlation functions. For small supercells at low temperature, one can use linear spin wave theory and its multi-boson generalization. Alternatively, one can use the full classical dynamics to study systems with large supercells (e.g., disordered systems), or anharmonic effects with thermal fluctuations.</li><li>Long-range dipole-dipole interactions accelerated with the fast Fourier transform (FFT).</li><li>Various correction factors to facilitate comparison with experimental data (form factor, dipole factor, temperature-dependent classical-to-quantum factors, intensity binning, etc.).</li></ul></article><nav class="docs-footer"><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="Tuesday 22 August 2023 18:11">Tuesday 22 August 2023</span>. Using Julia version 1.9.2.</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><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><li><a class="tocitem" href="examples/one_dim_chain/">Fitting model parameters in a 1D spin-1 ferromagnetic chain</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-Overview"><a class="docs-heading-anchor" href="#Sunny-Overview">Sunny Overview</a><a id="Sunny-Overview-1"></a><a class="docs-heading-anchor-permalink" href="#Sunny-Overview" title="Permalink"></a></h1><p><a href="https://github.com/SunnySuite/Sunny.jl/">Sunny</a> is a Julia package for modeling atomic-scale magnetism. It provides powerful tools to study equilibrium and non-equilibrium magnetic phenomena. In particular, it allows estimation of dynamical structure factor intensities, <span>$\mathcal{S}(𝐪,ω)$</span>, to support quantitative modeling of experimental scattering data.</p><p><strong>Features include</strong>:</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>Interactive visualizations of the 3D crystals and magnetic ordering.</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, and optimization tools.</li><li>Measurements of dynamical correlation functions. For small supercells at low temperature, one can use linear spin wave theory and its multi-boson generalization. Alternatively, one can use the full classical dynamics to study systems with large supercells (e.g., disordered systems), or anharmonic effects with thermal fluctuations.</li><li>Long-range dipole-dipole interactions accelerated with the fast Fourier transform (FFT).</li><li>Various correction factors to facilitate comparison with experimental data (form factor, dipole factor, temperature-dependent classical-to-quantum factors, intensity binning, etc.).</li></ul></article><nav class="docs-footer"><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 23 August 2023 18:07">Wednesday 23 August 2023</span>. Using Julia version 1.9.2.</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