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

Held Suarez test case #36

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Held Suarez test case #36

wants to merge 4 commits into from

Conversation

Witt-D
Copy link
Collaborator

@Witt-D Witt-D commented Dec 17, 2024

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 added the case study Pull requests or issues relating to adding or amending a case study label Dec 17, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants