Cylc User Guide

Cylc is a job meta-scheduler developed by NIWA and the UK Met Office. It is designed to handle dependencies between runs and organise run resubmissions.

Please watch the youtube talk by Hilary Oliver: http://www.youtube.com/watch?v=Mv-hBTcncKM.

Setting up

Cylc requires passwordless connection to the supercomputer in order to submit jobs.

Passwordless access to the supercomputer is only available using a passphrase-protected ssh-agent set up on your local computer. Instructions for setting this up are available in the SSH user guide.

Usage

A full user-guide for Cylc is available on the Cylc homepage. Only site-specific details are listed here.

suite.rc

The cylc installation on accessdev is setup to use a wrapper script raijin:~access/bin/cylc. This loads the module for the appropriate matching version so it's not necessary to load any rose/cylc modules in either your raijin shell environment or your suite.

With cylc 6 PBS directives can be specified on separate lines, so a sample suite.rc for raijin might include something like

[runtime]
    [root](/ACCESS-NRI/accessdev-Trac-archive/wiki/root)
        [[remote](/ACCESS-NRI/accessdev-Trac-archive/wiki/[remote)]
            host = raijin.nci.org.au
        [[job submission](/ACCESS-NRI/accessdev-Trac-archive/wiki/[job-submission)]
            method = pbs
        [[directives](/ACCESS-NRI/accessdev-Trac-archive/wiki/[directives)]
            -l walltime=1:00
            -l ncpus=1
            -l mem=500mb

See TotalviewCylc for notes on using the totalview debugger from within a suite.

See CylcSix for information on the differences between cylc versions 5 and 6 and how to upgrade to the new version.