Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decide on examples directory structure #29

Open
tristanmontoya opened this issue Aug 17, 2024 · 1 comment
Open

Decide on examples directory structure #29

tristanmontoya opened this issue Aug 17, 2024 · 1 comment

Comments

@tristanmontoya
Copy link
Member

We should definitely organize the examples directory into subdirectories as this package becomes larger, but I am not sure if it makes sense to do so based on solver/mesh type the way Trixi.jl does. Since this package already provides several independent features relating to the physical aspects (i.e. the moist Euler equations) and geometrical aspects (i.e. solving PDEs on 2D manifolds in 3D) of atmospheric modelling, it is perhaps most natural to split the examples in such a way, for example, into examples/moist_euler/ and examples/spherical_advection/.

A separate question that we will need to address at some point is how to organize the subdirectories in src/ and whether a similar division makes sense there, or if we should continue to mimic the structure of Trixi.jl.

@tristanmontoya tristanmontoya added question Further information is requested and removed question Further information is requested labels Aug 17, 2024
@benegee
Copy link
Collaborator

benegee commented Aug 20, 2024

Absolutely agree! In general and also regarding the first level of our hierarchy: equation for moisture and PDEs on manifold are our current main features.

For the moist equations I would further like to keep information about the concrete set of equations (e.e.g authors) and the mesh type. This could be another level in a directory hierarchy or part of the file name.

As always we can and should revise this as soon as some directories get cluttered up. I would suggest the same for /src.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants