added readme to data folder

[cwittens]

I think the data folder should have a README acknowledging the source (or sources for future data) similar to https://github.com/ranocha/2024_serre_green_naghdi/blob/main/code/Dingemans_data/README.md

[JoshuaLampert]

We already refer to the source in data_dingemans, but I agree it makes sense to also include it in a README in the data folder for people looking into the data folder and not into the docstring of the function returning the data.

[github-actions]

Benchmark Results (Julia v1.10)

Time benchmarks

	main	4ceaff1...	main / 4ceaff1...
bbm_1d/bbm_1d_basic.jl - rhs!:	14 ± 0.43 μs	13.9 ± 0.69 μs	1.01 ± 0.059
bbm_1d/bbm_1d_fourier.jl - rhs!:	0.224 ± 0.14 ms	0.534 ± 0.0093 ms	0.418 ± 0.27
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	0.0807 ± 0.00039 ms	0.0808 ± 0.00043 ms	1 ± 0.0072
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	0.0341 ± 0.00049 ms	0.0345 ± 0.0013 ms	0.991 ± 0.041
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	29.6 ± 0.58 μs	27.6 ± 0.57 μs	1.07 ± 0.031
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	0.0483 ± 0.0006 ms	0.0485 ± 0.0021 ms	0.996 ± 0.044
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	4.2 ± 0.03 μs	4.27 ± 0.03 μs	0.984 ± 0.0099
kdv_1d/kdv_1d_basic.jl - rhs!:	1.4 ± 0.019 μs	1.42 ± 0.019 μs	0.986 ± 0.019
kdv_1d/kdv_1d_implicit.jl - rhs!:	1.42 ± 0.011 μs	1.42 ± 0.019 μs	1 ± 0.015
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.198 ± 0.0083 ms	0.195 ± 0.0077 ms	1.01 ± 0.058
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.148 ± 0.0043 ms	0.143 ± 0.0032 ms	1.03 ± 0.038
time_to_load	1.87 ± 0.0084 s	1.87 ± 0.0022 s	1 ± 0.0046

Memory benchmarks

	main	4ceaff1...	main / 4ceaff1...
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

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[coveralls]

Pull Request Test Coverage Report for Build 17441488466

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 98.301%

---

Totals
Change from base Build 17295357873:	0.0%
Covered Lines:	2314
Relevant Lines:	2354

---

💛 - Coveralls

[JoshuaLampert]

Thanks! Looks good to me.