Mention that models are one-dimensional

[JoshuaLampert]

We should clarify that DispersiveShallowWater.jl only implements one-dimensional models (up to now). Suggested in openjournals/joss-reviews#8894 (comment).

[github-actions]

Benchmark Results (Julia v1.10)

Time benchmarks

	main	4ccb664...	main / 4ccb664...
bbm_1d/bbm_1d_basic.jl - rhs!:	13.7 ± 0.28 μs	13.8 ± 0.29 μs	0.991 ± 0.029
bbm_1d/bbm_1d_fourier.jl - rhs!:	0.214 ± 0.0088 ms	0.526 ± 0.32 ms	0.407 ± 0.25
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	0.0817 ± 0.00031 ms	0.0803 ± 0.00027 ms	1.02 ± 0.0052
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	0.0341 ± 0.00048 ms	0.0344 ± 0.00051 ms	0.992 ± 0.02
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	27.2 ± 0.47 μs	28.3 ± 0.67 μs	0.96 ± 0.028
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	0.0483 ± 0.00055 ms	0.0485 ± 0.00055 ms	0.996 ± 0.016
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	4.35 ± 0.04 μs	4.22 ± 0.03 μs	1.03 ± 0.012
kdv_1d/kdv_1d_basic.jl - rhs!:	1.46 ± 0.03 μs	1.46 ± 0.01 μs	1 ± 0.022
kdv_1d/kdv_1d_implicit.jl - rhs!:	1.46 ± 0.029 μs	1.4 ± 0.011 μs	1.04 ± 0.022
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.195 ± 0.0084 ms	0.199 ± 0.0089 ms	0.984 ± 0.061
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.145 ± 0.0033 ms	0.146 ± 0.0041 ms	0.989 ± 0.036
time_to_load	1.97 ± 0.0024 s	1.99 ± 0.018 s	0.991 ± 0.0088

Memory benchmarks

	main	4ccb664...	main / 4ccb664...
bbm_1d/bbm_1d_basic.jl - rhs!:	1 allocs: 4.12 kB	1 allocs: 4.12 kB	1
bbm_1d/bbm_1d_fourier.jl - rhs!:	1 allocs: 4.12 kB	1 allocs: 4.12 kB	1
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	5 allocs: 1.17 kB	5 allocs: 1.17 kB	1
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	10 allocs: 8.62 kB	10 allocs: 8.62 kB	1
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	2 allocs: 8.25 kB	2 allocs: 8.25 kB	1
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	2 allocs: 8.25 kB	2 allocs: 8.25 kB	1
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
kdv_1d/kdv_1d_basic.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
kdv_1d/kdv_1d_implicit.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.075 k allocs: 0.66 MB	0.075 k allocs: 0.66 MB	1
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.042 k allocs: 0.315 MB	0.042 k allocs: 0.315 MB	1
time_to_load	0.153 k allocs: 14.5 kB	0.153 k allocs: 14.5 kB	1

[jatkinson1000]

Come here from the JOSS pre-review, and entirely unrelated to the paper, I see there are a bunch of pending CI jobs for what is a non-code change. You may be interested in my colleague's green CI work, in-particular here the section on 'Triggers' to tailor what checks are run for changes to certain filetypes etc.

[JoshuaLampert]

Thanks a lot for the suggestion @jatkinson1000. This indeed sounds interesting. Can you provide a link, please so I can take a look?

[jatkinson1000]

Sigh, I forgot to paste in the link.
It's late here...

Here you go: https://github.com/Cambridge-ICCS/green-ci