This page contains a summary of significant changes across all Cylc components for each release.
For more detail see the component changelogs:
- cylc-flow-changelog
- cylc-uiserver-changelog
- cylc-ui-changelog
- cylc-rose-changelog
- metomi-rose-changelog
- metomi-isodatetime-changelog
Cylc Components
TODO
At Cylc 8.3.0, the cylc set-outputs command has been replaced by the new cylc set command.
The cylc set-outputs command made it look like an output had been generated to downstream tasks, but did not update the task status to match. As a result, it was often necessary to use cylc remove in combination with cylc set-outputs.
The new cylc set command is able to directly set task outputs as if they had completed naturally, making the command more intuitive and avoiding the need for cylc remove. It can also set prerequisites, as if they were satisfied naturally.
For example, say there's a failed task holding up your workflow and you want Cylc to continue as if the task had succeeded. Here are the interventions you would need to perform with Cylc 8.2 and 8.3 side-by-side.
| Cylc 8.2 (set-outputs) | Cylc 8.3 (set) |
# let downstream tasks run:
cylc set-outputs <task>
# remove the failed task:
cylc remove <task> |
# tell Cylc that the task succeeded:
cylc set <task> |
 |
 |
The Tui (terminal user interface) is a command line version of the Gui. You can use it to monitor and control your workflows.
There has been a major update to Tui at Cylc 8.3.0, you can now use Tui to browse your installed workflows. Tui is also able to keep up with larger workflows which would previously have caused it to time out.
The n-window determines how much of a workflow is visible in the GUI / Tui.
The n=0 window contains only the active tasks (i.e. queued, preparing, submitted or running tasks).
The n=1 window, also contains tasks one "edge" out from active tasks (i.e. the tasks immediately upstream or downstream of active tasks).
The n=2 window, also contains tasks two "edges" out from active tasks, and so on.
It is now possible to change the window extent in the GUI via a button in the toolbar allowing you to see tasks further back in the workflow's history.
Note
This is currently a per-workflow setting so changing the n-window in one browser tab will also change it in other browser tabs and Tui sessions.
Warning
Using high n-window values with complex workflows may have performance impacts.
cylc-uiserver 1.4.4
The UI now remembers the layout of your workspace tabs when you navigate away from that workflow. Note that this only applies per browser session.
Cylc now ignores $PYTHONPATH to make it more robust to task environments which set this value. If you want to add to the Cylc environment itself, e.g. to install a Cylc extension, use a custom xtrigger, or event handler use $CYLC_PYTHONPATH.
cylc-uiserver 1.4.0
The Cylc UI Server has been updated to work with the latest releases of Jupyter Server and Jupyter Hub.
If you are utilising Cylc's multi-user functionality then your configuration will require some changes to work with these releases.
See cylc.uiserver.multi-user for more details
cylc-uiserver 1.3.0
You can now configure the view which is opened by default when you navigate to a new workflow in the GUI. Navigate to the settings page to select your chosen view.
In the future we plan to support configuring a layout of multiple views and configuring certain options on those views.
cylc-flow 8.2.0
When workflows are reloaded <Reloading The Workflow Configuration At Runtime>, (e.g. by cylc reload), Cylc will now pause the workflow and wait for any preparing tasks to be submitted before proceeding with the reload. Once the reload has been completed, the workflow will be resumed.
You can now see more information about the status of the reload in the workflow status message which appears at the top of the GUI and Tui interfaces.
Warning
Workflows started with Cylc 8.0 which contain multiple flows <flow> cannot be restarted with Cylc 8.1 due to database changes.
cylc-uiserver 1.2.2
The web UI also has a new view for displaying task queue & run time statistics.
cylc-uiserver 1.2.0
The web UI now has a graph view which displays a visualisation of a workflow's graph:
Family & cycle grouping as well as the ability to view graphs for stopped workflows will be added in later releases.
cylc-uiserver 1.2.0
The web UI now has a log view which displays workflow and job log files:
Support for viewing more log files, syntax highlighting, searching and line numbers are planned for future releases.
cylc-uiserver 1.2.0
The web UI now has a command for editing the :cylc[runtime] section of a task or family.
Any changes made are broadcast <cylc-broadcast> to the running workflow.
cylc-flow 8.1.0
Two new commands have been added as short-cuts for common working patterns:
cylc vipValidate, install and plays a workflow, equivalent to:
cylc validate <path> cylc install <path> cylc play <id>
cylc vrValidate and reinstall a workflow, then either: - reload the workflow if it is running. - restart the workflow if it is stopped.
For more information see the command line help:
cylc vip --help
cylc vr --helpcylc-flow 8.1.0
Cylc now provides a high performance Bash completion script which saves you typing:
- Cylc commands & options
- Workflow IDs
- Cycle points
- Task names
- Job numbers
Installation instructions <installation.shell_auto_completion>.
The first official release of Cylc 8.
For a summary of changes see the migration guide<728.overview>.