Checklist for Adding or Modifying a Regtest

Checklist for Adding or Modifying a Regtest

1. Make sure any relevant information is added to the "info" file.
2. Add appropriate configurations to regtest/bin/matrix.base file. Try to group the regtests to minimize recompiling when possible.
3. If there are any new binary or large files (>20MB): Communicate via issue or pull request for the file to be added to the ftp tar file; Add the file name to the .gitignore; Add the copying of the files from the ftp in the ww3_from_ftp.sh script in the model/bin directory
4. Add new regtests to list of tests in manual (manual/impl/test_it.tex) or add it to your to-do list in your issue for other documentation updates.

Other helpful tips in creating regtests

• Run the ./bin/run_test script without options to see all of the possible options.
• See the list of regtests below to see if you can add as a new feature to an exisiting test possibly through a new input directory to an existing test or where the best place is to put a new regtest.
• Each regtest is comprised of a "info" file and "input" directories. In the input directories, you will put your ww3_.inp/nml files. The run_test script will take care of running them for you. If you have multiple input files for the same program for prep/post steps, simply use ww3_prep_.inp/nml and the script will automatically run the multiple programs. For grid and multi see the -g and -m options of bin/run_test for details.
• If your input files have paths to other files, the path to that file will be ./../input/nameoffile where input will need to be updated to the specific input file if you have multiple files.