Skip to content

Commit

Permalink
build based on fd9a518
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 21, 2024
1 parent 0fe6f8a commit ac803bd
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -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>StochasticSeriesExpansion.jl · StochasticSeriesExpansion.jl</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"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">StochasticSeriesExpansion.jl</a></span></div><form class="docs-search" action="search.html"><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="index.html">StochasticSeriesExpansion.jl</a><ul class="internal"><li><a class="tocitem" href="#Features"><span>Features</span></a></li><li><a class="tocitem" href="#Getting-started"><span>Getting started</span></a></li><li><a class="tocitem" href="#Can-I-simulate-my-own-model?"><span>Can I simulate my own model?</span></a></li></ul></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="tutorial.html">Tutorial</a></li><li><a class="tocitem" href="models.html">Predefined models</a></li><li><a class="tocitem" href="parameters.html">Parameters</a></li></ul></li><li><span class="tocitem">Implementing custom models</span><ul><li><a class="tocitem" href="interfaces.html">Interfaces</a></li><li><a class="tocitem" href="sse_data.html">Simulation data structure</a></li></ul></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="index.html">StochasticSeriesExpansion.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">StochasticSeriesExpansion.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/lukas-weber/StochasticSeriesExpansion.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="StochasticSeriesExpansion.jl"><a class="docs-heading-anchor" href="#StochasticSeriesExpansion.jl">StochasticSeriesExpansion.jl</a><a id="StochasticSeriesExpansion.jl-1"></a><a class="docs-heading-anchor-permalink" href="#StochasticSeriesExpansion.jl" title="Permalink"></a></h1><p>An implementation of the stochastic series expansion (SSE) quantum Monte Carlo algorithm for Julia.</p><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><ul><li>Run high-performance SSE simulations without being a QMC expert</li><li>Supports anisotropic spin-<span>$S$</span> quantum magnets out of the box</li><li>Extensible to arbitrary models (but may suffer from sign problem)</li></ul><h2 id="Getting-started"><a class="docs-heading-anchor" href="#Getting-started">Getting started</a><a id="Getting-started-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-started" title="Permalink"></a></h2><p>Jump right into the Tutorial (TODO).</p><h2 id="Can-I-simulate-my-own-model?"><a class="docs-heading-anchor" href="#Can-I-simulate-my-own-model?">Can I simulate my own model?</a><a id="Can-I-simulate-my-own-model?-1"></a><a class="docs-heading-anchor-permalink" href="#Can-I-simulate-my-own-model?" title="Permalink"></a></h2><p>Yes, by implementing the <a href="interfaces.html#abstract_model">AbstractModel</a> interface, which requires you the graph of bonds and arbitrary bond operators that describe your Hamiltonian. A key ingredient of the implementation is the “abstract loop” algorithm which will automatically figure out a set of worm updates (which is traditionally choosen by hand). How well the algorithm performs in practice depends on the model, in particular if there is a sign problem. So far it has been applied to</p><ul><li><a href="https://doi.org/10.1038/s42005-023-01359-x">Heisenberg-type magnets with various anisotropic terms in the single-site <span>$S^z$</span> basis</a></li><li><a href="https://doi.org/10.21468/scipostphys.12.2.054">Frustrated Heisenberg magnets in multi-site bases</a></li><li><a href="https://doi.org/10.1103/physrevb.100.054437">Magnets coupled to cavity photons</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial.html">Tutorial »</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="Thursday 21 November 2024 15:31">Thursday 21 November 2024</span>. Using Julia version 1.10.6.</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>StochasticSeriesExpansion.jl · StochasticSeriesExpansion.jl</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"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">StochasticSeriesExpansion.jl</a></span></div><form class="docs-search" action="search.html"><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="index.html">StochasticSeriesExpansion.jl</a><ul class="internal"><li><a class="tocitem" href="#Features"><span>Features</span></a></li><li><a class="tocitem" href="#Getting-started"><span>Getting started</span></a></li><li><a class="tocitem" href="#Can-I-simulate-my-own-model?"><span>Can I simulate my own model?</span></a></li></ul></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="tutorial.html">Tutorial</a></li><li><a class="tocitem" href="models.html">Predefined models</a></li><li><a class="tocitem" href="parameters.html">Parameters</a></li></ul></li><li><span class="tocitem">Implementing custom models</span><ul><li><a class="tocitem" href="interfaces.html">Interfaces</a></li><li><a class="tocitem" href="sse_data.html">Simulation data structure</a></li></ul></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="index.html">StochasticSeriesExpansion.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="index.html">StochasticSeriesExpansion.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/lukas-weber/StochasticSeriesExpansion.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="StochasticSeriesExpansion.jl"><a class="docs-heading-anchor" href="#StochasticSeriesExpansion.jl">StochasticSeriesExpansion.jl</a><a id="StochasticSeriesExpansion.jl-1"></a><a class="docs-heading-anchor-permalink" href="#StochasticSeriesExpansion.jl" title="Permalink"></a></h1><p>An implementation of the stochastic series expansion (SSE) quantum Monte Carlo algorithm for Julia.</p><h2 id="Features"><a class="docs-heading-anchor" href="#Features">Features</a><a id="Features-1"></a><a class="docs-heading-anchor-permalink" href="#Features" title="Permalink"></a></h2><ul><li>Run high-performance SSE simulations without being a QMC expert</li><li>Supports anisotropic spin-<span>$S$</span> quantum magnets out of the box</li><li>Extensible to arbitrary models (but may suffer from sign problem)</li></ul><h2 id="Getting-started"><a class="docs-heading-anchor" href="#Getting-started">Getting started</a><a id="Getting-started-1"></a><a class="docs-heading-anchor-permalink" href="#Getting-started" title="Permalink"></a></h2><p>Jump right into the Tutorial (TODO).</p><h2 id="Can-I-simulate-my-own-model?"><a class="docs-heading-anchor" href="#Can-I-simulate-my-own-model?">Can I simulate my own model?</a><a id="Can-I-simulate-my-own-model?-1"></a><a class="docs-heading-anchor-permalink" href="#Can-I-simulate-my-own-model?" title="Permalink"></a></h2><p>Yes, by implementing the <a href="interfaces.html#abstract_model">AbstractModel</a> interface, which requires you the graph of bonds and arbitrary bond operators that describe your Hamiltonian. A key ingredient of the implementation is the “abstract loop” algorithm which will automatically figure out a set of worm updates (which is traditionally choosen by hand). How well the algorithm performs in practice depends on the model, in particular if there is a sign problem. So far it has been applied to</p><ul><li><a href="https://doi.org/10.1038/s42005-023-01359-x">Heisenberg-type magnets with various anisotropic terms in the single-site <span>$S^z$</span> basis</a></li><li><a href="https://doi.org/10.21468/scipostphys.12.2.054">Frustrated Heisenberg magnets in multi-site bases</a></li><li><a href="https://doi.org/10.1103/physrevb.100.054437">Magnets coupled to cavity photons</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial.html">Tutorial »</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="Thursday 21 November 2024 15:36">Thursday 21 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ac803bd

Please sign in to comment.