Skip to content

Commit

Permalink
build based on 7f1a5db
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 23, 2023
1 parent 7a2456b commit 7dffead
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-23T13:06:45","documenter_version":"1.1.2"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-23T13:27:41","documenter_version":"1.1.2"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · DispersiveShallowWater.jl</title><meta name="title" content="Home · DispersiveShallowWater.jl"/><meta property="og:title" content="Home · DispersiveShallowWater.jl"/><meta property="twitter:title" content="Home · DispersiveShallowWater.jl"/><meta name="description" content="Documentation for DispersiveShallowWater.jl."/><meta property="og:description" content="Documentation for DispersiveShallowWater.jl."/><meta property="twitter:description" content="Documentation for DispersiveShallowWater.jl."/><meta property="og:url" content="https://JoshuaLampert.github.io/DispersiveShallowWater.jl/stable/"/><meta property="twitter:url" content="https://JoshuaLampert.github.io/DispersiveShallowWater.jl/stable/"/><link rel="canonical" href="https://JoshuaLampert.github.io/DispersiveShallowWater.jl/stable/"/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="search_index.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>DispersiveShallowWater.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li class="toplevel"><a class="tocitem" href="#Usage"><span>Usage</span></a></li><li class="toplevel"><a class="tocitem" href="#Authors"><span>Authors</span></a></li><li class="toplevel"><a class="tocitem" href="#License-and-contributing"><span>License and contributing</span></a></li></ul></li><li><a class="tocitem" href="overview/">Overview</a></li><li><a class="tocitem" href="reproduce/">Reproduce figures</a></li><li><a class="tocitem" href="ref/">Reference</a></li><li><a class="tocitem" href="license/">License</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/blob/main/docs/src/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="DispersiveShallowWater.jl"><a class="docs-heading-anchor" href="#DispersiveShallowWater.jl">DispersiveShallowWater.jl</a><a id="DispersiveShallowWater.jl-1"></a><a class="docs-heading-anchor-permalink" href="#DispersiveShallowWater.jl" title="Permalink"></a></h1><p><a href="https://JoshuaLampert.github.io/DispersiveShallowWater.jl/stable"><img src="https://img.shields.io/badge/docs-stable-blue.svg" alt="Docs-stable"/></a> <a href="https://JoshuaLampert.github.io/DispersiveShallowWater.jl/dev/"><img src="https://img.shields.io/badge/docs-dev-blue.svg" alt="Docs-dev"/></a> <a href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/actions/workflows/CI.yml?query=branch%3Amain"><img src="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/actions/workflows/CI.yml/badge.svg?branch=main" alt="Build Status"/></a> <a href="https://coveralls.io/github/JoshuaLampert/DispersiveShallowWater.jl?branch=main"><img src="https://coveralls.io/repos/github/JoshuaLampert/DispersiveShallowWater.jl/badge.svg?branch=main" alt="Coveralls"/></a> <a href="https://github.com/JuliaTesting/Aqua.jl"><img src="https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg" alt="Aqua QA"/></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-success.svg" alt="License: MIT"/></a></p><p><a href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl"><strong>DispersiveShallowWater.jl</strong></a> is a <a href="https://julialang.org/">Julia</a> package that implements structure-preserving numerical methods for dispersive shallow water models. To date, it provides provably conservative, entropy-conserving and well-balanced numerical schemes for two dispersive shallow water models:</p><ul><li>the <a href="https://iopscience.iop.org/article/10.1088/1361-6544/ac3c29">BBM-BBM equations with varying bottom topography</a>,</li><li>the <a href="https://arxiv.org/abs/2302.09924">dispersive shallow water model proposed by Magnus Svärd and Henrik Kalisch</a>.</li></ul><p>The semidiscretizations are based on summation by parts (SBP) operators, which are implemented in <a href="https://github.com/ranocha/SummationByPartsOperators.jl/">SummationByPartsOperators.jl</a>. In order to obtain fully discrete schemes, the time integration methods from <a href="https://github.com/SciML/OrdinaryDiffEq.jl">OrdinaryDiffEq.jl</a> are used to solve the resulting ordinary differential equations. Fully discrete entropy-conservative methods can be obtained by using the <a href="https://epubs.siam.org/doi/10.1137/19M1263662">relaxation method</a> provided by DispersiveShallowWater.jl.</p><h1 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h1><p>If you have not yet installed Julia, then you first need to <a href="https://julialang.org/downloads/">download Julia</a>. Please <a href="https://julialang.org/downloads/platform/">follow the instructions for your operating system</a>. DispersiveShallowWater.jl works with Julia v1.8 and newer. DispersiveShallowWater.jl is a registered Julia package. Therefore, you can install it by executing the following commands from the Julia REPL</p><pre><code class="language-julia hljs">julia&gt; using Pkg

julia&gt; Pkg.add([&quot;DispersiveShallowWater&quot;, &quot;OrdinaryDiffEq&quot;, &quot;Plots&quot;])</code></pre><p>In addition, this installs the packages <a href="https://github.com/SciML/OrdinaryDiffEq.jl">OrdinaryDiffEq.jl</a> used for time-integration and <a href="https://github.com/JuliaPlots/Plots.jl">Plots.jl</a> to visualize the results. If you want to use other SBP operators than the default operators that DispersiveShallowWater.jl uses, then you also need <a href="https://github.com/ranocha/SummationByPartsOperators.jl">SummationByPartsOperators.jl</a>, which can be installed running</p><pre><code class="language-julia hljs">julia&gt; Pkg.add(&quot;SummationByPartsOperators&quot;)</code></pre><h1 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h1><p>In the Julia REPL, first load the package DispersiveShallowWater.jl</p><pre><code class="language-julia hljs">julia&gt; using DispersiveShallowWater</code></pre><p>You can run a basic simulation that solves the BBM-BBM equations by executing</p><pre><code class="language-julia hljs">julia&gt; include(default_example());</code></pre><p>The result can be visualized by using the package Plots.jl</p><pre><code class="language-julia hljs">julia&gt; using Plots
julia&gt; plot(semi =&gt; sol)</code></pre><p>The command <code>plot</code> expects a <code>Pair</code> consisting of a <a href="ref/#DispersiveShallowWater.Semidiscretization"><code>Semidiscretization</code></a> and an <code>ODESolution</code>. The visualization can also be customized, see the <a href="overview/#visualize_results">documentation</a> for more details. Other examples can be found in the subdirectory <a href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/tree/main/examples">examples/</a>. A list of all examples is returned by running <a href="ref/#DispersiveShallowWater.get_examples-Tuple{}"><code>get_examples()</code></a>. You can pass the filename of one of the examples or your own simulation file to <code>include</code> in order to run it, e.g., <code>include(joinpath(examples_dir(), &quot;svaerd_kalisch_1d&quot;, &quot;svaerd_kalisch_1d_dingemans_relaxation.jl&quot;))</code>.</p><h1 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></h1><p>The package is developed and maintained by Joshua Lampert and was initiated as part of the master thesis &quot;Structure-Preserving Numerical Methods for Dispersive Shallow Water Models&quot; (2023). 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><h1 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></h1><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Monday 23 October 2023 13:06">Monday 23 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; plot(semi =&gt; sol)</code></pre><p>The command <code>plot</code> expects a <code>Pair</code> consisting of a <a href="ref/#DispersiveShallowWater.Semidiscretization"><code>Semidiscretization</code></a> and an <code>ODESolution</code>. The visualization can also be customized, see the <a href="overview/#visualize_results">documentation</a> for more details. Other examples can be found in the subdirectory <a href="https://github.com/JoshuaLampert/DispersiveShallowWater.jl/tree/main/examples">examples/</a>. A list of all examples is returned by running <a href="ref/#DispersiveShallowWater.get_examples-Tuple{}"><code>get_examples()</code></a>. You can pass the filename of one of the examples or your own simulation file to <code>include</code> in order to run it, e.g., <code>include(joinpath(examples_dir(), &quot;svaerd_kalisch_1d&quot;, &quot;svaerd_kalisch_1d_dingemans_relaxation.jl&quot;))</code>.</p><h1 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></h1><p>The package is developed and maintained by Joshua Lampert and was initiated as part of the master thesis &quot;Structure-Preserving Numerical Methods for Dispersive Shallow Water Models&quot; (2023). 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><h1 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></h1><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Monday 23 October 2023 13:27">Monday 23 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 7dffead

Please sign in to comment.