Tutorial section on framework page

[CaelonCragin]

I'm relatively new to contributing on github and I found this repo as an extension of the trixi.jl class. I was hoping to get experience contributing and I noticed that the framework for TrixiAtmo.jl doesn't have a tutorials section similar to the Trixi.jl framework. I was hoping to contribute by adding that section with a few sections documenting how to do tutorials.

Is there any preference within this repo on what package to use for the documentation such as documenter.jl.

Also is there any specific examples or use cases that I should focus on to start with?

[tristanmontoya]

Hi @CaelonCragin, it's great that you found our repo! We're happy to have new contributors, and it would be nice to have some tutorials.

Regarding the creation and formatting of the tutorials, I would suggest taking a similar approach to the rest of the Trixi.jl ecosystem, using Documenter.jl and Literate.jl. In particular, TrixiShallowWater.jl's documentation could be used as an example, as it similarly extends Trixi.jl.

Regarding specific use cases, I think we would eventually want to have the following tutorials (listed here roughly in order of simple to complex):

1. Set up a rising bubble case for the Euler equations with gravity, and then add moisture and rain.
2. Set up a mountain case and compare the results to a reference solution and/or linear theory.
3. Solve the spherical shallow water equations using the covariant approach (and perhaps also the Cartesian formulation based on the Lagrange-multiplier approach). Many of the standard test problems are solved in the reproducibility repository for our recent paper in Journal of Computational Physics. We could eventually extend this to compare results on cubed sphere (P4estMesh) and icosahedral (DGMultiMesh) grids.
4. A three-dimensional case like the baroclinic instability or Held-Suarez test.

Happy to hear from you (or others in the community) if you have other suggestions though!