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
  • EmPy
  • 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
• Running Workflows
  • Start, Restart, Reload
  • Task & Job States
  • Tasks in the UI
  • Retrying Tasks
  • Tracking Job Status
  • Workflow Completion
  • Scheduler Stall
  • Concurrent Flows
  • Simulation Modes
  • Scheduler Logs
  • Cylc Broadcast
  • Client-Server Interaction
  • Authentication Files
  • Workflow Run Databases
  • Handling Job Preemption
• Task Implementation
  • Task Implementation
  • Job Submission and Management
  • Remote Job Management
• Removing Workflows
  • Cleaning on remote install targets
  • Cleaning specific subdirectories or files
  • A note on symlink directories
• Authorizing Others to Access Your Workflows
  • Jupyter Hub Authorisation
  • Jupyter Server Authorisation
  • Cylc User Authorisation
  • Cylc Site Configuration
  • Interacting with Others’ Workflows
  • Troubleshooting Authorization
• Compound Commands
  • cylc vip (Validate, Install and Play)
  • cylc vr (Validate, Reinstall and Reload or Play)