README.md

Awesome Cylc

A curated list of Cylc workflows and useful resources. Please feel free to contribute!

Each item specifies the Cylc main versions it is compatible with. For exemple, "[7/8] Cylc VSCode Extension" means that this IDE extension is compatible with Cylc 7 and 8.

Table of Contents

Fully-Fledged Workflows | Workflow Design Patterns | Cylc Plugins | CI/CD | Syntax Highlighting | Research Papers | Presentations | Videos | Miscellaneous

Fully-Fledged Workflows

• [8] Cylc-GeoFabrics - A workflow for automating the use of GeoFabrics on NeSI.
• [8] RTMet - A workflow to process mass spectrometry data for metabolomics.
• [8] Cylc-Log-Analysis - A workflow for asynchronously archiving and analysing cylc job logs from multiple workflows.
• [7] CMIP6 Workflows - Workflows used for the CMIP6 experiments that NCAR participated in.
• [7] eWaterCycle - Workflow of the eWaterCycle forecasting system.

Workflow Design Patterns

• [7/8] Tim's Simple Cylc Examples - A collection of minimal Cylc workflows highlighting different features.
• [8] Cylc Patterns - A collection of commonly used Cylc workflow patterns.
• [8] Sub-Workflow - A workflow run by a task in another workflow.
• [8] File-Driven Workflow - Emulating Snakemake-like data processing.
• [7] Tasks in Conda Envs - A Cylc workflow template where tasks can be run inside Conda virtual environments.

Cylc Plugins

• [8] Cylc-Rose Plugin - A Cylc plugin providing support for the Rose rose-suite.conf file. Cylc 8 and Rose 2.

CI/CD

• [7/8] Cylc Sphinx Extensions - Official library of Sphinx extensions for documenting Cylc projects.

Syntax Highlighting

• [7/8] Cylc VSCode Extension
• [8] Cylc TextMate Bundle - For TextMate, Sublime Text, PyCharm, WebStorm and other editors.
• [8] Other IDEs - Instructions for enabling syntax highlighting in other editors (Atom, Emacs, Gedit, Kate, Vim).

Research Papers

• Workflow Automation for Cycling Systems, Oliver et al. - Original Cylc publication.
• Automated model optimisation using the Cylc workflow engine (Cyclops v1.0), Gormat et Oliver - How to use Cylc and NLops for geophysical model parameters tuning.

Presentations

• [7/8] Cylc Presentations - Official list of presentations by the Cylc team.

Videos

• [8] IS-ENES3 Webinar - Introduction to the Cylc workflow engine by Oliver Sanders (2023).
• [8] NeSI Webinar - Workflow Orchestration with Cylc 8 on NeSI Platforms, Hilary Oliver (2022).

Miscellaneous

• [7/8] Altair Weather Solution - Commercial support for Cylc from Altair, using Altair PBS Professional™ for workload management. Blog article.