Skip to content

Commit

Permalink
build based on a026665
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 23, 2023
1 parent 246397c commit b85e6c3
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
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-09-21T11:58:33","documenter_version":"1.0.1"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-09-23T13:18:12","documenter_version":"1.0.1"}}
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
julia> Pkg.add(url="https://github.com/JoshuaLampert/DispersiveShallowWater.jl")

julia&gt; Pkg.add([&quot;OrdinaryDiffEq&quot;, &quot;Plots&quot;])</code></pre><p>The last command installs also the package &quot;OrdinaryDiffEq.jl&quot; used for time-integration and &quot;Plots.jl&quot; to visualize the results. If you want to use other SBP operators than the default operators that DispersiveShallowWater.jl uses, you also need SummationByPartsOperators.jl, 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.0.1 on <span class="colophon-date" title="Thursday 21 September 2023 11:58">Thursday 21 September 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.0.1 on <span class="colophon-date" title="Saturday 23 September 2023 13:18">Saturday 23 September 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 b85e6c3

Please sign in to comment.