From 1bfd5c7b56a553671505529e2a9358f90fff97ce Mon Sep 17 00:00:00 2001 From: Joshua Lampert Date: Wed, 8 Nov 2023 02:34:34 +0100 Subject: [PATCH 1/2] adjust header size in README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e6ebbb00..3470042c 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ In order to obtain fully discrete schemes, the time integration methods from [Or Fully discrete entropy-conservative methods can be obtained by using the [relaxation method](https://epubs.siam.org/doi/10.1137/19M1263662) provided by DispersiveShallowWater.jl. A more detailed documentation can be found [online](https://JoshuaLampert.github.io./DispersiveShallowWater.jl/stable/). -# Installation +## Installation If you have not yet installed Julia, then you first need to [download Julia](https://julialang.org/downloads/). Please [follow the instructions for your operating system](https://julialang.org/downloads/platform/). 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 @@ -35,7 +35,7 @@ which can be installed running julia> Pkg.add("SummationByPartsOperators") ``` -# Usage +## Usage In the Julia REPL, first load the package DispersiveShallowWater.jl ```julia @@ -56,12 +56,12 @@ for more details. Other examples can be found in the subdirectory [examples/](ht A list of all examples is returned by running `get_examples()`. You can pass the filename of one of the examples or your own simulation file to `include` in order to run it, e.g., `include(joinpath(examples_dir(), "svaerd_kalisch_1d", "svaerd_kalisch_1d_dingemans_relaxation.jl"))`. -# Authors +## Authors The package is developed and maintained by Joshua Lampert and was initiated as part of the master thesis "Structure-Preserving Numerical Methods for Dispersive Shallow Water Models" (2023). Some parts of this repository are based on parts of [Dispersive-wave-schemes-notebooks. A Broad Class of Conservative Numerical Methods for Dispersive Wave Equations](https://github.com/ranocha/Dispersive-wave-schemes-notebooks) by Hendrik Ranocha, Dimitrios Mitsotakis and David Ketcheson. The code structure is inspired by [Trixi.jl](https://github.com/trixi-framework/Trixi.jl/). -# License and contributing +## License and contributing DispersiveShallowWater.jl is published under the MIT license (see [License](https://github.com/JoshuaLampert/DispersiveShallowWater.jl/blob/main/LICENSE)). We are pleased to accept contributions from everyone, preferably in the form of a PR. From 0c544cbaae34a7ea60e4f1edd209763a72d441c9 Mon Sep 17 00:00:00 2001 From: Joshua Lampert Date: Wed, 8 Nov 2023 02:38:34 +0100 Subject: [PATCH 2/2] don't run CI on changes to SpellCheck.yml --- .github/workflows/CI.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index e781a5a5..2819d0b1 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -9,6 +9,7 @@ on: - 'README.md' - '.github/workflows/CompatHelper.yml' - '.github/workflows/TagBot.yml' + - '.github/workflows/SpellCheck.yml' - 'docs/**' pull_request: paths-ignore: @@ -16,6 +17,7 @@ on: - 'README.md' - '.github/workflows/CompatHelper.yml' - '.github/workflows/TagBot.yml' + - '.github/workflows/SpellCheck.yml' - 'docs/**' workflow_dispatch: