build based on b5eb9d5

previews/PR134/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-08-17T08:53:26","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-08-17T11:45:45","documenter_version":"1.5.0"}}

previews/PR134/development/index.html

@@ -4,4 +4,4 @@
 mkdir run
 cd run
 julia --project=. -e 'using Pkg; Pkg.develop(PackageSpec(path=".."))' # Install local DispersiveShallowWater.jl clone
-julia --project=. -e &#39;using Pkg; Pkg.add([&quot;OrdinaryDiffEq&quot;, &quot;Plots&quot;, &quot;SummationByPartsOperators&quot;])&#39; # Install additional packages</code></pre><p>If you use other packages for executing DispersiveShallowWater.jl, you can add them to the project in the <code>run</code> directory in an analogous way as above. To use the Julia project within <code>run</code>, be sure to start the Julia REPL by</p><pre><code class="language-sh hljs">julia --project=.</code></pre><p>if already inside the the <code>run</code> directory or <code>julia --project=run</code> if in the main directory of the repo.</p><h2 id="Preview-of-the-documentation"><a class="docs-heading-anchor" href="#Preview-of-the-documentation">Preview of the documentation</a><a id="Preview-of-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Preview-of-the-documentation" title="Permalink"></a></h2><p>If you want to build the documentation locally, you can run</p><pre><code class="language-sh hljs">julia --project=docs -e &#39;using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()&#39;</code></pre><p>once from the DispersiveShallowWater.jl main directory to tell <a href="https://documenter.juliadocs.org/stable/man/guide/">Documenter.jl</a> to build the documentation of your local clone. To build the documentation, run</p><pre><code class="language-sh hljs">julia --project=docs --color=yes docs/make.jl</code></pre><p>The resulting <code>.html</code> files can then be found in <code>docs/build/</code> and you can look at them by opening them in a browser. For pull requests from the main repository (i.e. not from a fork), the documentation is automatically built and can be previewed under <code>https://joshualampert.github.io/DispersiveShallowWater.jl/previews/PRXXX/</code> where <code>XXX</code> is the number of the pull request.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</a><a class="docs-footer-nextpage" href="../ref-trixibase/">TrixiBase »</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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 08:53">Saturday 17 August 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia --project=. -e &#39;using Pkg; Pkg.add([&quot;OrdinaryDiffEq&quot;, &quot;Plots&quot;, &quot;SummationByPartsOperators&quot;])&#39; # Install additional packages</code></pre><p>If you use other packages for executing DispersiveShallowWater.jl, you can add them to the project in the <code>run</code> directory in an analogous way as above. To use the Julia project within <code>run</code>, be sure to start the Julia REPL by</p><pre><code class="language-sh hljs">julia --project=.</code></pre><p>if already inside the the <code>run</code> directory or <code>julia --project=run</code> if in the main directory of the repo.</p><h2 id="Preview-of-the-documentation"><a class="docs-heading-anchor" href="#Preview-of-the-documentation">Preview of the documentation</a><a id="Preview-of-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Preview-of-the-documentation" title="Permalink"></a></h2><p>If you want to build the documentation locally, you can run</p><pre><code class="language-sh hljs">julia --project=docs -e &#39;using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()&#39;</code></pre><p>once from the DispersiveShallowWater.jl main directory to tell <a href="https://documenter.juliadocs.org/stable/man/guide/">Documenter.jl</a> to build the documentation of your local clone. To build the documentation, run</p><pre><code class="language-sh hljs">julia --project=docs --color=yes docs/make.jl</code></pre><p>The resulting <code>.html</code> files can then be found in <code>docs/build/</code> and you can look at them by opening them in a browser. For pull requests from the main repository (i.e. not from a fork), the documentation is automatically built and can be previewed under <code>https://joshualampert.github.io/DispersiveShallowWater.jl/previews/PRXXX/</code> where <code>XXX</code> is the number of the pull request.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</a><a class="docs-footer-nextpage" href="../ref-trixibase/">TrixiBase »</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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 11:45">Saturday 17 August 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR134/index.html

@@ -10,4 +10,4 @@
   month={10},
   howpublished={\url{https://github.com/JoshuaLampert/DispersiveShallowWater.jl}},
   doi={10.5281/zenodo.10034636}
-}</code></pre><h2 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h2><p>The package is developed and maintained by Joshua Lampert (University of Hamburg). Some parts of this repository are based on parts of <a href="https://github.com/ranocha/Dispersive-wave-schemes-notebooks">Dispersive-wave-schemes-notebooks. A Broad Class of Conservative Numerical Methods for Dispersive Wave Equations</a> by Hendrik Ranocha, Dimitrios Mitsotakis and David Ketcheson. The code structure is inspired by <a href="https://github.com/trixi-framework/Trixi.jl/">Trixi.jl</a>.</p><h2 id="License-and-contributing"><a class="docs-heading-anchor" href="#License-and-contributing">License and contributing</a><a id="License-and-contributing-1"></a><a class="docs-heading-anchor-permalink" href="#License-and-contributing" title="Permalink"></a></h2><p>DispersiveShallowWater.jl is published under the MIT license (see <a href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/blob/main/LICENSE">License</a>). We are pleased to accept contributions from everyone, preferably in the form of a PR.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="overview/">Overview »</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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 08:53">Saturday 17 August 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre><h2 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h2><p>The package is developed and maintained by Joshua Lampert (University of Hamburg). Some parts of this repository are based on parts of <a href="https://github.com/ranocha/Dispersive-wave-schemes-notebooks">Dispersive-wave-schemes-notebooks. A Broad Class of Conservative Numerical Methods for Dispersive Wave Equations</a> by Hendrik Ranocha, Dimitrios Mitsotakis and David Ketcheson. The code structure is inspired by <a href="https://github.com/trixi-framework/Trixi.jl/">Trixi.jl</a>.</p><h2 id="License-and-contributing"><a class="docs-heading-anchor" href="#License-and-contributing">License and contributing</a><a id="License-and-contributing-1"></a><a class="docs-heading-anchor-permalink" href="#License-and-contributing" title="Permalink"></a></h2><p>DispersiveShallowWater.jl is published under the MIT license (see <a href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/blob/main/LICENSE">License</a>). We are pleased to accept contributions from everyone, preferably in the form of a PR.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="overview/">Overview »</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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 11:45">Saturday 17 August 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>