You can initiate your Cylc command from either the Gadi login node or the persistent session. They involve slightly different steps.
ROSE_ORIG_HOST† | Steps |
|---|---|
ARE VDI or Gadi login node | 0. Specify Target Session
|
Persistent Session |
|
†ROSE_ORIG_HOST is the host where you run "cylc/rose" commands to start the workflow.
Here are the quick links to individual steps. If your own suite fails to run after following the instructions on this page, try an example suite first. We have examples suite run available for testing your environment.
No matter which way in the above table you are using, the workflow will keep running at the persistent session and you can view its progress later.
Note
Charging rate using persistent session local resources is high. Try to avoid using local resources at the persistent session, such as running Cylc GUI in Gadi login node rather than in the persistent session.
Specify Target Session
A user may have several active sessions concurrently. It's essential to specify which specific session you intend to use for running the Cylc8 suites before loading the environment module.
There are two ways of specify the session:
- In runtime through the environment variable CYLC_SESSION
- Or in the file
~/.persistent-sessions/cylc-sessionto avoid setting the environment variable every time before loading the module.
An example file reads as the following.
[abc111@gadi-login-02 ~]$ more ~/.persistent-sessions/cylc-session cylc-test.abc111.xy99.ps.gadi.nci.org.au
Please note that the cylc module will initially attempt to retrieve the session name from the CYLC_SESSION environment variable. In cases where the CYLC_SESSION environment variable is not available, the module will then seek to obtain the session name from the file ~/.persistent-sessions/cylc-session. If neither of them exists, loading the module fails.
After the module loaded, the file `~/.persistent-sessions/cylc-session` will be updated with the name of the last used target session.
Load the Cylc Module
From the ROSE_ORIG_HOST, you need to load the Cylc8 module first before starting your Cylc8 suite.
$ module use /g/data/hr22/modulefiles $ module load cylc/8.2.1
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
$ mosrs-auth
will lead you through the MOSRS authentication.
If you have one of the following directories missing,
- ~/.gnupg
- ~/.metomi
- ~/.subversion
it will go through the MOSRS configuration setup, asking for your MOSRS account once and the corresponding password twice. Otherwise, it refreshes your MOSRS credentials.
Start Your Cylc Suite
Before starting your suite run, if the suite is going to run for the first time using a persistent session inside Gadi, please double check our suggestions to prepare the suite.
From the ROSE_ORIG_HOST, you could start your Cylc8 suite under ~/roses directory. For example, you could start a suite with the following command or other ones:
$ cylc install $ cylc play u-cz535
Check the last several line of the output to make sure it is running inside your persistent session.
$ cylc play u-cz535 Loading cylc/8.2.1 Loading requirement: mosrs-setup/1.0.1 ▪ ■ Cylc Workflow Engine 8.2.1 ██ Copyright (C) 2008-2023 NIWA ▝▘ & British Crown (Met Office) & Contributors 2023-09-14T14:48:19+10:00 INFO - Extracting job.sh to /home/111/abc111/cylc- run/u-cz535/run1/.service/etc/job.sh u-cz535/run1: cylc-test.abc111.xy99.ps.gadi.nci.org.au PID=22637
Now your suite starts running at the persistent session and you can quit Gadi login node or ARE VDI.
Monitor Your Cylc Suite Run
Your Cylc8 workflow continues to operate within the persistent session. You have the flexibility to monitor its progress conveniently by executing the following commands in the ARE VDI session.
$ module use /g/data/hr22/modulefiles $ module load cylc/8.2.1 $ cylc gui