Developer Guide

Jump to bottom

Emma Hogan edited this page Feb 20, 2023 · 33 revisions

Cylc recommendations

See the Cylc: Workflow Design Guide.

Run the tests locally

Navigate to the workflow directory:
```
cd <path_to>/CMEW/CMEW
```
Run the workflow tests; these tests ensure that the expected output files are generated by CMEW (ESMValTool tests, e.g. the Recipe Test Workflow, ensures the contents of the output files are as expected):
```
export CYLC_VERSION=8
cylc vip -O metoffice -O test
```
Ensure the tests pass, see, e.g. http://fcm1/cylc-review/.

Build the documentation locally

Activate the environment for the current session, where <version> is the version of ESMValTool to use (the following command only needs to be executed once per session):
```
module load scitools/community/esmvaltool/<version>
```
Build the documentation:
```
cd <path_to>/CMEW/doc
make html
```
View the documentation:
```
gio open build/html/index.html
```

Validate the workflow locally

Navigate 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/
```