Interacting with Active Cylc Workflow Suites#
The following are commonly used Cylc <= 7.9.3 features that allow a user to interact with an active workflow suite. The variables used in the examples below are listed in the following table.
Variable |
Description |
|---|---|
|
The cycle timestamp; the format is |
|
The Cylc experiment name. |
|
A valid Cylc workflow suite task name. |
Monitoring a Workflow Suite#
A user can determine the status of an active workflow suite as follows.
user@host:$ /path/to/cylc mon EXPERIMENT_NAME
Pausing and Releasing Workflow Tasks#
An active workflow suite may be paused as follows.
user@host:$ /path/to/cylc hold EXPERIMENT_NAME
To release the respective hold, follow this step.
user@host:$ /path/to/cylc release EXPERIMENT_NAME
Individual tasks and cycles may also be paused.
user@host:$ cylc hold EXPERIMENT_NAME TASK_NAME.DTG
Similarly a paused task may be released as follows.
user@host:$ cylc release EXPERIMENT_NAME TASK_NAME.DTG
Stopping a Workflow#
A user can shut down all non-active workflow tasks (e.g., those not yet launched/queued) as follows.
user@host:$ /path/to/cylc stop EXPERIMENT_NAME
The above will allow the currently launched tasks, including those queued, to complete. In contrast, the following will terminate all tasks within the active workflow suite.
user@host:$ /path/to/cylc stop --now --now EXPERIMENT_NAME
Restarting Failed Workflow Tasks#
Failed workflow suite tasks may be restarted as follows.
user@host:$ /path/to/cylc trigger EXPERIMENT_NAME TASK_NAME.DTG
A user can also modify the status of a given workflow suite task. The following method is useful in cases where problematic forecast cycle tasks need to be overridden without disrupting an active Cylc workflow suite.
user@host:$ /path/to/cylc reset --state=succeeded EXPERIMENT_NAME TASK_NAME.DTG
To restart a stopped Cylc workflow suite, do the following.
user@host:$ /path/to/cylc trigger EXPERIMENT_NAME
To restart specific Cylc workflow suite tasks, do the following.
user@host:$ /path/to/cylc trigger EXPERIMENT_NAME TASK_NAME.DTG