Awesome Cylc

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

Each entry specifies the main Cylc versions it supports. For example, "8️⃣|7️⃣ Cylc VSCode Extension" means the extension works with both Cylc 7 and 8.

Table of Contents

🌍 Real-World Workflows | 🧩 Templates & Design Patterns | 🧰 Tooling & Extensions | 🚀 Deployments | 🎓 Learning & Presentations | 📚 Publications

🌍 Real-World Workflows

• 8️⃣ Cylc-GeoFabrics – Automates hydrological modelling workflows using GeoFabrics on NeSI.
• 8️⃣ RTMet – Processes mass spectrometry data for metabolomics.
• 8️⃣ Cylc-Log-Analysis – Asynchronously archives and analyses Cylc job logs from multiple workflows.
• 7️⃣ CMIP6 Workflows – Runs CMIP6 experiments at NCAR using CESM models.
• 7️⃣ eWaterCycle – Runs the forecasting workflow for the eWaterCycle system.

🧩 Templates & Design Patterns

• 8️⃣|7️⃣ Tim's Simple Cylc Examples – Minimal workflows showcasing key Cylc features.
• 8️⃣ Cylc Patterns – Commonly used workflow design patterns in Cylc.
• 8️⃣ Data in Cylc Workflows – A simple example to illustrate the relationship between Cylc workflows and the data they process.
• 8️⃣ Sub-Workflow – Demonstrates running a workflow from within a task of another.
• 8️⃣ File-Driven Workflow – Emulates Snakemake-style rule-based data processing.
• 7️⃣ Tasks in Conda Envs – Runs Cylc tasks inside Conda virtual environments.

🧰 Tooling & Extensions

• 8️⃣|7️⃣ Cylc VSCode Extension – Language support for .cylc workflow configuration files in Visual Studio Code.
• 8️⃣|7️⃣ Cylc Sphinx Extensions – Official Sphinx extensions for documenting Cylc projects.
• 8️⃣ Cylc-Rose Plugin – Support for rose-suite.conf files (Cylc 8 + Rose 2).
• 8️⃣ yProv4WFs – PROV-compatible provenance capture for Cylc and StreamFlow. See the setup guide.
• 8️⃣ Syntax Highlighting – How to enable syntax highlighting for .cylc files in popular editors.
• 8️⃣ Cylc TextMate Bundle – Syntax support for TextMate, Sublime Text, JetBrains IDEs, and more.
• 8️⃣ Tree-Sitter-Cylc – Tree-sitter grammar for .cylc files, compatible with Zed, Neovim, Helix, Pulsar, Emacs, etc.

🚀 Deployments

• 8️⃣|7️⃣ Altair Weather Solution – Commercial deployment of Cylc with Altair PBS Professional™. See the blog article for details on its use at the Australian Bureau of Meteorology.

🎓 Learning & Presentations

• 8️⃣|7️⃣ Cylc Presentations – Official slides and talks from the Cylc team.
• 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” by Hilary Oliver (2022).
• 8️⃣ yProv4WFs presented at SC24 – “A Software Ecosystem for Multi-Level Provenance Management in Large-Scale Scientific Workflows for AI Applications” (2024).

📚 Publications

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