Skip to content

Conversation

@tommbendall
Copy link
Collaborator

@tommbendall tommbendall commented Dec 9, 2024

Summary

This PR moves the "hydrostatic" Skamarock-Klemp gravity wave and "hydrostatic" mountain tests into this repo (and out of the main gusto repo).

Each test is now implemented with a hydrostatic argument, so that all tests can be run with hydrostatic or non-hydrostatic equation sets.

The "non-hydrostatic" mountain also has the hydrostatic argument added.

Still to do:

  • I am not happy with the results of the mountain_hydrostatic test. It's not clear whether this is a problem with the initial conditions...
  • figures need adding once the "hydrostatic" equation set is working

Add or update a Gusto case study

Here is a checklist of things that should be done to add a new case study to
the repository:

  • The case study has been prepared from the case studies template in templates/template_case_study.py. This ensures that the case study:
    • begins with documentation of the case
    • includes a dictionary of default argument values
    • is run through a function
    • follows the standard order of sections:
      1. test case parameters
      2. set up of model objects
      3. initial conditions
      4. run
    • includes a __main__ routine with arg-parsing of command line arguments
  • The case study has a quick-to-run test form in the relevant test_*.py file, so that it will be run as part of CI
  • A plotting script has been added to the relevant plotting directory, with a name that matches the case study script
  • Neat figures have been added to the relevant figures directory, with names that match the case study script

Add or update a plotting script

Here is a checklist of things that should be done to add a new plotting script to the repository:

  • The plotting script has been prepared from the template in templates/template_plotting_script.py or another acceptable plotting script
  • The plot follows the Good Plot Guide in tomplot/good_plot_guide.md
  • Relevant initial and final fields are plotted
  • The figures produced have been added to the repository

@tommbendall tommbendall marked this pull request as draft December 9, 2024 10:44
@tommbendall tommbendall added plotting script Pull requests or issues for adding a plotting script figure Pull requests or issues relating to a figure case study Pull requests or issues relating to adding or amending a case study tidying Pull requests or issues that involve tidying up code labels Dec 9, 2024
@tommbendall tommbendall marked this pull request as ready for review February 10, 2025 11:19
@tommbendall tommbendall merged commit bfd1bc9 into main Feb 10, 2025
3 checks passed
@tommbendall tommbendall deleted the TBendall/HydrostaticTests branch February 10, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

case study Pull requests or issues relating to adding or amending a case study figure Pull requests or issues relating to a figure plotting script Pull requests or issues for adding a plotting script tidying Pull requests or issues that involve tidying up code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants