The workflow

An overview of the workflow

CMEW performs the following steps:

install_env_file
Description:

Activates the environment for ESMValTool, based on the SITE provided

Runs on:

Localhost

Executes:

The install_env_file.sh script from the Rose app

Details:

Runs once at the start of the workflow

configure_recipe
Description:

Creates and modifies the ESMValTool user configuration file, and writes it to the cylc workflow share/etc directory

Runs on:

Localhost

Executes:

The configure_recipe.py script from the Rose app

Details:

Runs immediately after the successful completion of the install_env_file job. Temporarily, the modified ESMValTool developer configuration file is copied from the configure_recipe app to the share/etc directory in the installed workflow

configure_for
Description:

Copies an updated version of the ESMValTool recipe into the cylc workflow share/etc directory in the installed workflow

Runs on:

Localhost

Executes:

For the required recipe, executes the esmvaltool recipes get command followed by the update_recipe_file.py script from the Rose app

Details:

Runs once for each recipe, immediately after the successful completion of the install_env_file job. The recipe is updated with CMEW required variables (e.g. “Activity”: “ESMVal”) and also with user configurable variables from the Rose Edit GUI/rose-suite.conf

Families:

RECIPE

configure_standardise
Description:

Creates the request.json file and variables list which are needed to run CDDS and creates the CDDS directory structure.

Runs on:

Localhost

Executes:

The configure_standardise.sh script from the Rose app

Details:

Runs once for each recipe, immediately after the successful completion of the configure_for job

standardise_model_data
Description:

Launches the CDDS workflow and converts the data into a CMIP compliant format for ESMValTool

Runs on:

Localhost

Executes:

The cdds_convert command and the restructure_dirs.sh script from the Rose app

Details:

Runs after the successful completion of the configure_standardise job. The restructure_dirs.sh script moves the standardised data into a directory with a BADC DRS structure so that ESMValTool can find the data

housekeeping
Description:

Removes any intermediate files from the cylc run directory that were created by the CDDS workflow in standardise_model_data

Runs on:

Localhost

Executes:

The rose_prune application

Details:

Runs after the successful completion of the standardise_model_data job

run_recipe
Description:

Runs the requested recipes using ESMValTool

Runs on:

COMPUTE, which depends on the SITE; at the Met Office, the run_recipe jobs will run on SPICE

Executes:

The ESMValTool command line script

Details:

Runs once for each recipe, after the successful completion of the standardise_model_data and the configure_recipe jobs

Families:

COMPUTE, RECIPE

compare
Description:

Ensures the expected output files are generated by the run_recipe jobs

Runs on:

Localhost

Executes:

The compare.sh script from the Rose app

Details:

Runs for every recipe defined in the workflow, after the completion of the run_recipe job

unittest
Description:

Locates and runs unit tests for the python scripts inside the app directory

Runs on:

Localhost

Executes:

pytest from the Rose app

Details:

Runs on its own when -O unittest command is invoked, or runs alongside the full workflow when running with -O test

Design considerations

Portability

CMEW is portable; site-specific information can be found in the site and opt directories within the workflow. The files required are:

site/<site>.cylc

Contains task definitions specific to the SITE, for example, COMPUTE

site/<site>-standardise-env

Contains details on how to set up the environment for CDDS at the SITE

site/<site>-esmvaltool-env

Contains details on how to set up the environment for ESMValTool at the SITE

opt/rose-suite-<site>.conf

Contains configuration items specific to the SITE, including SITE

Families

Several tasks in CMEW are grouped into families with shared configurations. The following families are used in the workflow:

COMPUTE

A family that is inherited by computationally intensive tasks

RECIPE

A family that is inherited by tasks that run for each recipe independently

Metadata

CMEW uses Rose metadata. Every item defined in the suite configuration file (rose-suite.conf) will have an entry in the main metadata configuration file (meta/rose-meta.conf).

Resources

The resources used by the run_recipe jobs are defined in the site/<site>.cylc file, allowing the jobs to be configured by SITE as well as by recipe. This ensures only the required resources are requested when running each of the run_recipe jobs.