Skip to content
Draft
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
d7f411f
add first JOSS paper draft
JoshuaLampert Aug 21, 2025
c5855fc
add missing dashes
JoshuaLampert Aug 21, 2025
20a5d2e
add first two sections
JoshuaLampert Aug 21, 2025
8c8c859
add features section
JoshuaLampert Aug 21, 2025
cf8dbef
typos and abbreviation
JoshuaLampert Aug 21, 2025
158739e
unified months
JoshuaLampert Aug 21, 2025
b998d51
section on related research and software
JoshuaLampert Aug 21, 2025
cae93fd
exclude bib file from typos
JoshuaLampert Aug 21, 2025
376a784
add tags
JoshuaLampert Aug 21, 2025
074db48
some small changes
JoshuaLampert Aug 21, 2025
f53d470
Apply suggestions from code review
JoshuaLampert Aug 21, 2025
234addf
Update paper/paper.md
JoshuaLampert Aug 21, 2025
81ad3a6
Update paper/paper.md
JoshuaLampert Aug 21, 2025
4052f55
Update paper/paper.md
JoshuaLampert Aug 21, 2025
3455467
Apply suggestions from code review
JoshuaLampert Aug 21, 2025
e5db237
Apply suggestions from code review
JoshuaLampert Aug 22, 2025
c68cae1
Update paper/paper.md
JoshuaLampert Aug 22, 2025
1945c44
Update paper/paper.md
JoshuaLampert Aug 22, 2025
7fc3d0b
Update paper/paper.md
JoshuaLampert Aug 22, 2025
7642281
address target users more clearly
JoshuaLampert Aug 22, 2025
b7a713e
Merge branch 'main' into paper-2025-joss
JoshuaLampert Aug 22, 2025
e320fea
Update paper/paper.md
JoshuaLampert Aug 22, 2025
5dcf1d0
Update paper/paper.md
JoshuaLampert Aug 22, 2025
066017d
Merge branch 'main' into paper-2025-joss
JoshuaLampert Aug 22, 2025
91244b3
add date to Basilisk website reference
ranocha Aug 22, 2025
b07bdb8
more other codes
ranocha Aug 22, 2025
f251c16
reformulate
ranocha Aug 22, 2025
d7581b7
add reference to Oceananigans.jl and TrixiShallowWater.jl
JoshuaLampert Aug 22, 2025
3b0d1ea
Merge branch 'main' into paper-2025-joss
ranocha Aug 28, 2025
a9f5127
Merge branch 'main' into paper-2025-joss
JoshuaLampert Aug 28, 2025
3088913
fix typo
JoshuaLampert Aug 28, 2025
2ae926f
Merge branch 'paper-2025-joss' of https://github.com/JoshuaLampert/Di…
JoshuaLampert Aug 28, 2025
0c68b2b
Merge branch 'main' into paper-2025-joss
JoshuaLampert Aug 28, 2025
634701f
add arXiv DOIs
JoshuaLampert Aug 30, 2025
3aa77a7
Merge branch 'paper-2025-joss' of https://github.com/JoshuaLampert/Di…
JoshuaLampert Aug 30, 2025
32e0edc
Merge branch 'main' into paper-2025-joss
JoshuaLampert Nov 8, 2025
a087a65
add references to additional Julia packages
JoshuaLampert Nov 8, 2025
59323ec
fix package name
JoshuaLampert Nov 8, 2025
f5c9954
add reference to ShallowWaters.jl
JoshuaLampert Nov 10, 2025
2ee9bec
accidentally deleted WaterWaves1D.jl
JoshuaLampert Nov 10, 2025
60e1e99
Merge branch 'main' into paper-2025-joss
JoshuaLampert Nov 10, 2025
441b6a3
update paper reference
JoshuaLampert Nov 10, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/PaperDraft.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Build JOSS paper draft PDF

on:
push:
paths:
- paper/**
- .github/workflows/PaperDraft.yml
pull_request:
paths:
- paper/**
- .github/workflows/PaperDraft.yml

jobs:
paper:
runs-on: ubuntu-latest
name: JOSS Paper Draft
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build draft PDF
uses: openjournals/openjournals-draft-action@master
with:
journal: joss
# This should be the path to the paper within your repo.
paper-path: paper/paper.md
- name: Upload
uses: actions/upload-artifact@v4
with:
name: paper
# This is the output path where Pandoc will write the compiled
# PDF. Note, this should be the same directory as the input
# paper.md
path: paper/paper.pdf
3 changes: 3 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
[default.extend-words]
ater = "ater" # Needed for {D}ispersive{S}hallow{W}ater.jl

[files]
extend-exclude = ["paper/paper.bib"]
313 changes: 313 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
@article{ranocha2021broad,
title = {A Broad Class of Conservative Numerical Methods for Dispersive Wave Equations},
author = {Ranocha, Hendrik and Mitsotakis, Dimitrios and Ketcheson, David I.},
year = {2021},
month = {06},
journal = {Communications in Computational Physics},
volume = {29},
number = {4},
pages = {979--1029},
doi = {10.4208/cicp.OA-2020-0119}
}

@article{ranocha2021rate,
title = {On the Rate of Error Growth in Time for Numerical Solutions of Nonlinear Dispersive Wave Equations},
author = {Ranocha, Hendrik and {de Luna}, Manuel Quezada and Ketcheson, David I.},
year = {2021},
month = {10},
journal = {Partial Differential Equations and Applications},
volume = {2},
number = {6},
pages = {76},
doi = {10.1007/s42985-021-00126-3}
}

@article{linders2023resolving,
title = {Resolving Entropy Growth from Iterative Methods},
author = {Linders, Viktor and Ranocha, Hendrik and Birken, Philipp},
year = {2023},
month = {09},
journal = {BIT Numerical Mathematics},
volume = {63},
number = {4},
pages = {45},
doi = {10.1007/s10543-023-00992-w}
}

@online{lampert2024structure,
title={Structure-Preserving Numerical Methods for Two Nonlinear Systems of
Dispersive Wave Equations},
author={Lampert, Joshua and Ranocha, Hendrik},
year={2024},
month={02},
eprint={2402.16669},
eprinttype={arxiv},
eprintclass={math.NA}
}

@article{ranocha2025structure,
title = {Structure-Preserving Approximations of the {S}erre-{G}reen-{N}aghdi
Equations in Standard and Hyperbolic Form},
author = {Ranocha, Hendrik and Ricchiuto, Mario},
year = {2025},
journal = {Numerical Methods for Partial Differential Equations},
volume = {41},
number = {4},
pages = {e70016},
doi = {10.1002/num.70016},
}

@online{biswas2024traveling,
title = {Traveling-Wave Solutions and Structure-Preserving Numerical Methods for a
Hyperbolic Approximation of the {{Korteweg-de Vries}} Equation},
author = {Biswas, Abhijit and Ketcheson, David I. and Ranocha, Hendrik and Sch{\"u}tz, Jochen},
year = {2024},
month = {12},
eprint = {2412.17117},
primaryclass = {math},
archiveprefix = {arXiv}
}

@article{korteweg1895change,
title = {On the Change of Form of Long Waves Advancing in a Rectangular Canal, and
on a New Type of Long Stationary Waves},
author = {Korteweg, Diederik and {de Vries}, Gustav},
year = {1895},
month = {05},
journal = {The London, Edinburgh, and Dublin Philosophical Magazine and Journal of Science},
publisher = {Taylor \& Francis},
volume = {39},
number = {240},
pages = {422--443},
doi = {10.1080/14786449508620739}
}

@article{benjamin1972model,
title = {Model Equations for Long Waves in Nonlinear Dispersive Systems},
author = {Benjamin, Thomas Brooke and Bona, Jerry Lloyd and Mahony, John Joseph},
year = {1972},
month = {03},
journal = {Philosophical Transactions of the Royal Society of London. Series A,
Mathematical and Physical Sciences},
publisher = {Royal Society},
volume = {272},
number = {1220},
pages = {47--78},
doi = {10.1098/rsta.1972.0032}
}

@article{bona1998boussinesq,
title = {A {{Boussinesq}} System for Two-Way Propagation of Nonlinear Dispersive Waves},
author = {Bona, Jerry L. and Chen, Min},
year = {1998},
month = {05},
journal = {Physica D: Nonlinear Phenomena},
volume = {116},
number = {1},
pages = {191--224},
doi = {10.1016/S0167-2789(97)00249-2}
}

@article{serre1953contribution,
title = {Contribution {\`a} l'{\'e}tude Des {\'E}coulements Permanents et Variables
Dans Les Canaux},
author = {Serre, Fran{\c c}ois},
year = {1953},
month = {06},
journal = {La Houille Blanche},
publisher = {Taylor \& Francis},
volume = {39},
number = {3},
pages = {374--388},
doi = {10.1051/lhb/1953034}
}

@article{green1976derivation,
title = {A Derivation of Equations for Wave Propagation in Water of Variable Depth},
author = {Green, Albert Edward and Naghdi, Paul Mansour},
year = {1976},
month = {11},
journal = {Journal of Fluid Mechanics},
volume = {78},
number = {2},
pages = {237--246},
doi = {10.1017/S0022112076002425}
}

@article{favrie2017rapid,
title = {A Rapid Numerical Method for Solving {S}erre--{G}reen--{N}aghdi
Equations Describing Long Free Surface Gravity Waves
},
author = {Favrie, Nicolas and Gavrilyuk, Sergey},
year = {2017},
month = {05},
journal = {Nonlinearity},
publisher = {IOP Publishing},
volume = {30},
number = {7},
pages = {2718},
doi = {10.1088/1361-6544/aa712d}
}

@article{svard2025novel,
title = {A Novel Energy-Bounded {B}oussinesq Model and a Well Balanced and Stable
Numerical Discretisation},
author = {Sv{\"a}rd, Magnus and Kalisch, Henrik},
year = {2025},
month = {01},
journal = {Journal of Computational Physics},
volume = {520},
pages = {113516},
doi = {10.1016/j.jcp.2024.113516}
}

@article{bezanson2017julia,
title={Julia: {A} Fresh Approach to Numerical Computing},
author={Bezanson, Jeff and Edelman, Alan and Karpinski, Stefan and
Shah, Viral B},
journal={SIAM Review},
volume={59},
number={1},
pages={65--98},
year={2017},
publisher={SIAM},
eprint={1411.1607},
eprinttype={arxiv},
eprintclass={cs.MS},
doi={10.1137/141000671}
}

@article{ranocha2021sbp,
title={{SummationByPartsOperators.jl}: {A} {J}ulia library of provably stable semidiscretization techniques with mimetic properties},
author={Ranocha, Hendrik},
journal={Journal of Open Source Software},
year={2021},
month={08},
doi={10.21105/joss.03454},
volume={6},
number={64},
pages={3454},
publisher={The Open Journal},
url={https://github.com/ranocha/SummationByPartsOperators.jl}
}

@article{rackauckas2017differentialequations,
title={{DifferentialEquations.jl} {--} {A} Performant and Feature-Rich
Ecosystem for Solving Differential Equations in {J}ulia},
author={Rackauckas, Christopher and Nie, Qing},
journal={Journal of Open Research Software},
volume={5},
number={1},
pages={15},
year={2017},
publisher={Ubiquity Press},
doi={10.5334/jors.151}
}

@article{christ2023plots,
author={Christ, Simon and Schwabeneder, Daniel and Rackauckas, Christopher
and Borregaard, Michael Krabbe and Breloff, Thomas},
title={Plots.jl --- a user extendable plotting {API} for the {J}ulia
programming language},
journal={Journal of Open Research Software},
volume={11},
number={1},
pages={5},
year={2023},
doi={10.5334/jors.431},
eprint={2204.08775},
eprinttype={arxiv},
eprintclass={cs.GR}
}

@article{ranocha2022adaptive,
title={Adaptive numerical simulations with {T}rixi.jl:
{A} case study of {J}ulia for scientific computing},
author={Ranocha, Hendrik and Schlottke-Lakemper, Michael and Winters, Andrew Ross
and Faulhaber, Erik and Chan, Jesse and Gassner, Gregor},
journal={Proceedings of the JuliaCon Conferences},
volume={1},
number={1},
pages={77},
year={2022},
doi={10.21105/jcon.00077},
eprint={2108.06476},
eprinttype={arXiv},
eprintclass={cs.MS}
}

@article{schlottkelakemper2021purely,
title={A purely hyperbolic discontinuous {G}alerkin approach for
self-gravitating gas dynamics},
author={Schlottke-Lakemper, Michael and Winters, Andrew R and
Ranocha, Hendrik and Gassner, Gregor J},
journal={Journal of Computational Physics},
pages={110467},
year={2021},
month={06},
volume={442},
publisher={Elsevier},
doi={10.1016/j.jcp.2021.110467},
eprint={2008.10593},
eprinttype={arXiv},
eprintclass={math.NA}
}

@misc{schlottkelakemper2025trixi,
title={{T}rixi.jl: {A}daptive high-order numerical simulations
of hyperbolic {PDE}s in {J}ulia},
author={Schlottke-Lakemper, Michael and Gassner, Gregor J and
Ranocha, Hendrik and Winters, Andrew R and Chan, Jesse
and Rueda-Ramírez, Andrés},
year={2025},
howpublished={\url{https://github.com/trixi-framework/Trixi.jl}},
doi={10.5281/zenodo.3996439}
}

@article{ketcheson2019relaxation,
title = {
Relaxation {R}unge--{K}utta Methods: {C}onservation and Stability for
Inner-Product Norms
},
author = {Ketcheson, David I.},
year = {2019},
month = {01},
journal = {SIAM Journal on Numerical Analysis},
publisher = {{Society for Industrial and Applied Mathematics}},
volume = {57},
number = {6},
pages = {2850--2870},
doi = {10.1137/19M1263662}
}

@article{ranocha2020relaxation,
title = {Relaxation {R}unge--{K}utta Methods: {F}ully Discrete Explicit
Entropy-Stable Schemes for the Compressible {E}uler and
{N}avier--{S}tokes Equations
},
author = {
Ranocha, Hendrik and Sayyari, Mohammed and Dalcin, Lisandro and Parsani,
Matteo and Ketcheson, David I.
},
year = {2020},
month = {01},
journal = {SIAM Journal on Scientific Computing},
publisher = {{Society for Industrial and Applied Mathematics}},
volume = {42},
number = {2},
pages = {A612-A638},
doi = {10.1137/19M1263480}
}

@article{glimsdal2013dispersion,
title = {Dispersion of Tsunamis: Does It Really Matter?},
author = {Glimsdal, S. and Pedersen, G. K. and Harbitz, C. B. and L{\o}vholt, F.},
year = {2013},
month = jun,
journal = {Natural Hazards and Earth System Sciences},
publisher = {Copernicus GmbH},
volume = {13},
number = {6},
pages = {1507--1526},
doi = {10.5194/nhess-13-1507-2013}
}
Loading
Loading