Developer Guide

Cylc recommendations

See the Cylc: Workflow Design Guide.

Run the tests locally

• Run the workflow tests; navigate to the directory containing the user workflow:

  cd <path_to>/CMEW/CMEW
  

  then run:

  export CYLC_VERSION=8
  cylc vip -O metoffice -O test
  

Build the documentation locally

• Build the documentation:

  cd <path_to>/CMEW/doc
  make html
  

• View the documentation:

  gio open build/html/index.html
  

Validate the workflow locally

• Change to the workflow directory:

  cd <path_to>/CMEW/CMEW
  
  

• Validate the Cylc workflow:

  cylc validate .
  

  Note: cylc validate only works after pre-processing Jinja2 branches.
• Run the Cylc configuration linter to help spot issues in unprocessed files:

  cylc lint
  

• Validate the format of Rose configuration files, and commit any changes:

  rose config-dump
  

• Validate the Rose configuration metadata:

  rose metadata-check -C meta/