This page outlines best practices for starting a Cylc7/8 workflow for new users without any predefined settings including SSH, persistent session etc.

To begin the workflow, log in to the Gadi head nodes using the ARE VDI or an SSH client installed on your local computer.

Check Group Memberships

First of all, you need to check whether you have access to some necessary projects before starting any step further. run the command `groups` like the following. 

In the return message, the matching string will be highlighted in red. The above example checks three project memberships: hr22, ki32 and access, but you might need more memberships as your suite needs. 

You only need to do this step once.

See details. 

Start a New Persistent Session 

You need to create a persistent session as below to start a cycle workflow. In the case below, our choice for session name is cylc-test, which then augmented for the full DNS name by the system, when it automatically adds the username, project code and persistent server being used - which in this example is then `cylc-test.abc111.xy99.ps.gadi.nci.org.au`.

See details. 

Login On the Persistent Session

Now you can log in to the active persistent session from the Gadi login node via SSH. You need "-Y" flag as below to monitor cylc 7 suite progress.

See details. 

Load the Cylc Module

Next you need to load a Cylc module within the persistent session. Note the module name "cylc" implies Cylc8, and the module name "cylc7" is used to run Cylc 7 suite.

[abc111@cylc-test ~]$ module use /g/data/hr22/modulefiles
[abc111@cylc-test ~]$ module load cylc7

[abc111@cylc-test ~]$ module use /g/data/hr22/modulefiles
[abc111@cylc-test ~]$ module load cylc

Set up MOSRS Access 

If this is the first time you run Cylc jobs on Gadi, it is very likely that you need to checkout suites from MOSRS before actually starting the suite run. In order do this, you need to do authentication first. Run the following command.

[abc111@cylc-test ~] mosrs-auth

It will lead you through the MOSRS authentication. 

See details.

Start Your Cylc Suite

You’re now ready to start a Cylc suite. Ensure that no modules are automatically loaded when you log in.

Cylc 7 example suite

You can run a UM suite using the Cylc 7 modules as shown below. 

[abc111@cylc-test ~]$ module purge
[abc111@cylc-test ~]$ module use /g/data/hr22/modulefiles
[abc111@cylc-test ~]$ module load cylc7
[abc111@cylc-test ~]$ cd ~/roses
[abc111@cylc-test ~]$ fcm co fcm:um.xm/trunk@vn13.7 um-trunk-13.7
[abc111@cylc-test ~]$ cd um-trunk-13.7/rose-stem
[abc111@cylc-test ~]$ rose stem --group=nci

You can monitor the suite’s progress through the Cylc 7 UI that appears.

Cylc example suite

You can run the Cylc 8 example suite u-cz535 using the following steps.

[abc111@cylc-test ~]$ module purge
[abc111@cylc-test ~]$ module use /g/data/hr22/modulefiles
[abc111@cylc-test ~]$ module load cylc
[abc111@cylc-test ~]$ cd ~/roses
[abc111@cylc-test ~]$ rosie co u-cz535
[INFO] u-cz535: local copy created at /home/111/abc111/roses/u-cz535
[abc111@cylc-test ~]$ cd u-cz535
[abc111@cylc-test ~]$ cylc install 
[abc111@cylc-test ~]$ cylc play u-cz535

You can monitor the suite’s progress as outlined here.

See details for Cylc 7 or Cylc 8.

For more information on each step, please refer to the link provided at the end of each step.