Using the UM11.4 test suite

Using the UM11.4 Suite

u-bk021

All Rose suites on MONsooN need to be executed as described in the instructions and not on the puma system.

1. Create a suitable folder for the suite. (default name ~/roses)
2. cd to the folder and create a copy of the Suite

   ~/roses $ rosie copy u-bk021

   This will create a copy of the suite (probably as) u-bANNN and check it out to the ~/roses folder.

3. To ensure that the base settings work for you:

   $ cd ~/roses/u-bANNN

   Only for Met Office users:

   rose edit

   Under suite conf --> jinja2 panel, select Site : Meto_cray

   Save and exit

   u-bANNN $ rose suite-run

   This will preprocess the configuration and launch the tasks in the background along with opening the gcylc window that displays the status of each task.

   Once all the tasks complete (Status = stopped with 'succeeded' or check output in Rose-bush), the Suite can now be modified to test your changes.

4. Execution options
   

   The suite can be executed as a combination of the following configurations, by setting values of the related variables via the Rose GUI (rose edit --> suite conf --> jinja2 ):

   Compilation (Build) On/Off: BUILD=true/false

   StratTrop Chemistry scheme: STRATTROP=true/false

   Offline Oxidants Chemistry scheme: OFFLINE=true/false

   Run KGO, PE, OpenMP, NRUN-CRUN and Rigorous build Tests: RUN_TESTS=true/false (additional option RUN_RIGOROUS=true/false)

   Setting both Offline & StratTrop options to false will convert the suite to a compile-only job.

   Additional Options:

   Change the length of the run(s): modify TASKEND='0,Months,Days,Hours,Minutes,0' (Note: Climate meaning and suite-cycling is Off, so the apps can be run only up to one month)

   Change the frequency of restart dumps: set DUMPFREQ=number-of-days

   Both these options are only available if testing is switched Off, since the tests require a specific run-length and dumping frequency.

5. Testing an UM11.4 branch

   If you are only making changes to the code and not modifying any namelists, the suite only needs to be pointed to the new branch:

   u-bANNN $ Edit app/fcm_make/rose-app.conf and add your branch at the line

   um_sources=branches/your-branch or um_sources=working-copy (full path)

   Note that since suites use the mirror of the Ex-UM respository, it takes 5-10 minutes for any recently committed changes to be available to the suite.

   Now rerun the suite:

   u-bANNN $ rose suite-run --new

   The --new option forces the removal (and fresh creation) of the extracted source, build and working folders thus ensuring that all modifications to the source code made in your branch are included.

   If any code changes are expected to change the results for this configuration, failure of the comparison against Known Good Output (KGO) i.e. the rose_ana_atmos_*_kgo tasks can be ignored. However, if the comparison tests fail unexpectedly, this indicates a bug somewhere in the implementation which needs to be traced, corrected and re-tested.

6. Namelist changes

   If there are any modifications to the namelists e.g. addition or deletion of items, moving items between namelists, these need to be applied in u-bANNN/app/um/rose-app.conf

   Note: Since the base app/um/rose-app.conf needs to work for both UKCA configurations, any new settings that are specific to a configuration need to be made in the optional configurations viz app/um/opt/rose-app.offline.conf and app/um/opt/rose-app-stratdiags.conf.

   For adding the accompanying metadata changes:

   Checkout your branch to an universal location i.e. $HOME or $DATADIR.

   Modify the meta-data file : your-working-copy/rose-meta/um-atmos/HEAD/rose-meta.conf to reflect the namelist changes.

   Edit the u-bANNN/app/um/rose-app.conf and replace the line:

   meta=um-atmos/vn11.4 with meta=your working copy/rose-meta/um-atmos/HEAD

   Open the apps with rose edit to ensure that the namelist changes are consistent with the metadata.

   Now rerun the suite to make sure the Rose namelist changes are consistent with the Fortran namelist changes.

7. Making and Testing changes to STASHmaster

   This is a bit more complicated as the changes required for Rose (i.e. GUI) to see the new STASHmaster are different to those required so that the 'run' or executable sees this.

   Changes for Rose/GUI to see the new STASHmaster = the same as other metadata changes

   Edit the u-bANNN/app/um/rose-app.conf and replace the line:

   meta=um-atmos/vn11.4 with meta=your working copy/rose-meta/um-atmos/HEAD

   Changes for the model/run to see the new STASHmaster

   Make sure to commit your STASHmaster_A changes to the branch

   In the app/um/rose-app.conf,in the [env] section add the line:

   STASHMASTER=STASHmaster

   and at the end of the [file:xxx] section, add the following two lines:

   [file:STASHmaster]

   source=fcm:um.xm_br/dev/user-id/branch-name/rose-meta/um-atmos/HEAD/etc/stash/STASHmaster@your-revision

   Commit the suite-changes and re-run as normal

Warning: If any of the tasks in the workflow fails, the corresponding housekeeping task will not be carried out and all the data generated will remain in $DATADIR/cylc-run/u-bANNN on the HPC. This may have to be cleaned manually after testing through the command:

u-bANNN $ rose suite-clean