Developer Guide

Jump to bottom

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

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 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

Validate the Cylc workflow:
```
cylc validate .
```
Run the Cylc configuration linter:
```
cylc lint
```
Validate the format of Rose configuration files:
```
rose config-dump
```
Validate the Rose configuration metadata:
```
rose metadata-check -C meta/
```