build based on a26ed3a

FourierFlows · Sep 7, 2023 · 52f1ce7 · 52f1ce7
1 parent c0a6c1b
commit 52f1ce7
Show file tree

Hide file tree

Showing 330 changed files with 131,510 additions and 16,318 deletions.
diff --git a/dev/aliasing/index.html b/dev/aliasing/index.html
diff --git a/dev/animation.mp4 b/dev/animation.mp4
diff --git a/dev/assets/themes/documenter-dark.css b/dev/assets/themes/documenter-dark.css
diff --git a/dev/assets/themes/documenter-light.css b/dev/assets/themes/documenter-light.css
diff --git a/dev/basics/index.html b/dev/basics/index.html
diff --git a/dev/contributing/index.html b/dev/contributing/index.html
diff --git a/dev/diagnostics/index.html b/dev/diagnostics/index.html
diff --git a/dev/gpu/index.html b/dev/gpu/index.html
diff --git a/dev/grids/index.html b/dev/grids/index.html
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/installation_instructions/index.html b/dev/installation_instructions/index.html
@@ -1,4 +1,3 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Installation Instructions · FourierFlows.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://fourierflows.github.io/FourierFlowsDocumentation/dev/installation_instructions/"/><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="../">FourierFlows.jl</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><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Installation Instructions</a></li><li><a class="tocitem" href="../basics/">Code Basics</a></li><li><a class="tocitem" href="../grids/">Grids</a></li><li><a class="tocitem" href="../aliasing/">Aliasing</a></li><li><a class="tocitem" href="../problem/">Problem</a></li><li><a class="tocitem" href="../diagnostics/">Diagnostics</a></li><li><a class="tocitem" href="../output/">Output</a></li><li><a class="tocitem" href="../gpu/">GPU</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../literated/OneDShallowWaterGeostrophicAdjustment/">Linear rotating shallow water dynamics</a></li></ul></li><li><a class="tocitem" href="../contributing/">Contributor&#39;s guide</a></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="../library/outline/">Contents</a></li><li><a class="tocitem" href="../library/public/">Public</a></li><li><a class="tocitem" href="../library/internals/">Private</a></li><li><a class="tocitem" href="../library/function_index/">Function index</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>Installation Instructions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Installation Instructions</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/FourierFlows/FourierFlows.jl/blob/main/docs/src/installation_instructions.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="Installation-instructions"><a class="docs-heading-anchor" href="#Installation-instructions">Installation instructions</a><a id="Installation-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Installation-instructions" title="Permalink"></a></h1><p>You can install the latest version of FourierFlows.jl via the built-in package manager  (accessed by pressing <code>]</code> in the Julia REPL command prompt) to add the package and also to  instantiate/build all the required dependencies</p><pre><code class="language-julia hljs">julia&gt;]
-(v1.6) pkg&gt; add FourierFlows
-(v1.6) pkg&gt; instantiate</code></pre><p>We recommend installing FourierFlows.jl with the built-in Julia package manager, because  this installs a stable, tagged release. Later on, you can update FourierFlows.jl to the  latest tagged release again via the package manager by typing</p><pre><code class="language-julia hljs">(v1.6) pkg&gt; update FourierFlows</code></pre><p>Note that some releases might induce breaking changes to certain modules. If after anything  happens or your code stops working, please open an <a href="https://github.com/FourierFlows/FourierFlows.jl/issues">issue</a>  or start a <a href="https://github.com/FourierFlows/FourierFlows.jl/discussions">discussion</a>. We&#39;re  more than happy to help with getting your simulations up and running.</p><div class="admonition is-category-warn"><header class="admonition-header">Use Julia 1.6 or newer</header><div class="admonition-body"><p>The latest FourierFlows.jl requires at least Julia v1.6 (the current long-term-release). Installing FourierFlows with an older version of Julia will install an older version  of FourierFlows.jl (the latest version compatible with your version of Julia).</p><p>Last version that works with Julia v1.5 is FourierFlows.jl v0.7.2.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../basics/">Code Basics »</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.23 on <span class="colophon-date" title="Tuesday 30 August 2022 11:22">Tuesday 30 August 2022</span>. Using Julia version 1.6.7.</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>Installation Instructions · FourierFlows.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://fourierflows.github.io/FourierFlowsDocumentation/stable/installation_instructions/"/><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="../">FourierFlows.jl</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><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Installation Instructions</a></li><li><a class="tocitem" href="../basics/">Code Basics</a></li><li><a class="tocitem" href="../grids/">Grids</a></li><li><a class="tocitem" href="../aliasing/">Aliasing</a></li><li><a class="tocitem" href="../problem/">Problem</a></li><li><a class="tocitem" href="../timestepping/">Time stepping</a></li><li><a class="tocitem" href="../diagnostics/">Diagnostics</a></li><li><a class="tocitem" href="../output/">Output</a></li><li><a class="tocitem" href="../gpu/">GPU</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../literated/OneDShallowWaterGeostrophicAdjustment/">Linear rotating shallow water dynamics</a></li></ul></li><li><a class="tocitem" href="../contributing/">Contributor&#39;s guide</a></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="../library/outline/">Contents</a></li><li><a class="tocitem" href="../library/public/">Public</a></li><li><a class="tocitem" href="../library/internals/">Private</a></li><li><a class="tocitem" href="../library/function_index/">Function index</a></li></ul></li><li><a class="tocitem" href="../references/">References</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>Installation Instructions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Installation Instructions</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/FourierFlows/FourierFlows.jl/blob/main/docs/src/installation_instructions.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="Installation-instructions"><a class="docs-heading-anchor" href="#Installation-instructions">Installation instructions</a><a id="Installation-instructions-1"></a><a class="docs-heading-anchor-permalink" href="#Installation-instructions" title="Permalink"></a></h1><p>To install the latest version of FourierFlows.jl use the Julia&#39;s built-in package manager (accessed by pressing <code>]</code> in the Julia REPL command prompt):</p><pre><code class="language-julia hljs">julia&gt; ]
+(v1.6) pkg&gt; add FourierFlows</code></pre><p>We recommend installing FourierFlows.jl with the built-in Julia package manager, because this installs a stable, tagged release. Later, you can update FourierFlows.jl to the latest tagged release again via the package manager by</p><pre><code class="language-julia hljs">(v1.6) pkg&gt; update FourierFlows</code></pre><p>Note that some releases might induce breaking changes to certain modules. If after anything happens or your code stops working, please open an <a href="https://github.com/FourierFlows/FourierFlows.jl/issues">issue</a>  or start a <a href="https://github.com/FourierFlows/FourierFlows.jl/discussions">discussion</a>. We&#39;re more than happy to help with getting your simulations up and running.</p><div class="admonition is-category-warn"><header class="admonition-header">Use Julia 1.6 or newer</header><div class="admonition-body"><p>The latest FourierFlows.jl requires at least Julia v1.6 (the current long-term-release). Installing FourierFlows with an older version of Julia will install an older version of FourierFlows.jl (the latest version compatible with your version of Julia).</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../basics/">Code Basics »</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 7 September 2023 14:36">Thursday 7 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/library/function_index/index.html b/dev/library/function_index/index.html