User Guide

• Introduction
  • What is a Workflow?
  • What is Cylc?
  • Cylc and Cycling Workflows
  • How to Run User Guide Examples
• Writing Workflows
  • Workflow Configuration
  • Scheduling Configuration
  • Task Configuration
  • Task Parameters
  • Jinja2
  • External Triggers
  • Suicide Triggers
  • Scheduler Configuration
• Installing Workflows
  • The Cylc Install Command
  • Using Cylc Install
  • The Cylc Install Process
  • Automatically Generated Directories and Files
  • Reinstalling a Workflow
  • Expected Errors
  • Compound Commands
• Running Workflows
  • Start, Restart, Reload
  • Tasks in the GUI/Tui
  • Retrying Tasks
  • Tracking Job Status
  • Workflow Completion
  • Scheduler Stall
  • Concurrent Flows
  • Workflow Run Modes
  • Workflow Logs
  • Cylc Broadcast
  • Client-Server Interaction
  • Authentication Files
  • Workflow Run Databases
  • Advanced
• Task Implementation
  • Task Implementation
  • Job Submission and Management
  • Remote Job Management
  • Skip Mode
• Interventions
  • Re-Run a Task
  • Re-Run Multiple Tasks
  • Re-Run All Failed Tasks
  • Set Task Outputs
  • Set Task Prerequisites
  • Set a Switch Task
  • Edit a Task’s Configuration and Re-Run It
  • Edit The Workflow Configuration
  • Orphan a “Stuck” Job Submission
  • Terminate a Chain of Automatic Retries
  • Hold The Workflow And Trigger Tasks One By One
  • I want to Skip a cycle of tasks and allow the workflow to continue
• Removing Workflows
  • Cleaning on remote install targets
  • Cleaning specific subdirectories or files
  • A note on symlink directories
• Cheat Sheet
  • Working with Workflows
  • Starting and Stopping Workflows
  • List Workflows
  • Opening the GUI/Tui
  • Making Changes To Running Workflows
  • Inspecting Workflows
  • Running Rose Stem Workflows
  • Interventions
  • Running Workflows in Debug Mode
  • Managing Multiple Workflows
  • Working With Cylc IDs
• Examples
  • Hello World
  • Integer Cycling
  • Datetime Cycling
  • Converging Workflow
  • Irregular Cycling
  • Event Driven Cycling
  • Extending Workflow
  • Using Data To Define Your Workflow
  • Inter-Workflow Triggering
• Troubleshooting
  • Log Files
  • Shell Login/Profile Files
  • Problems
  • Error Messages
  • Debugging Workflow Configurations
  • Getting Help