Editing a Workflow#

Now that you have successfully copied a workflow, you may want to make some changes to it. This could be to change the model configuration, add additional diagnostics, or change the length of the run.

Editing with Rose GUI#

To edit and view the workflow data, navigate into the roses/<suite-id> directory you just made. You should see the following files:

$ cd ~/roses/<suite-id>
$ ls
app  flow.cylc  meta  opt
README_cylc8  rose-suite.conf  rose-suite.info  site  tests.cylc

See also

For help choosing the correct Monsoon3 service and finding the official setup guidance, see Using Monsoon3.

$ cd ~/roses/<suite-id>
$ ls
app  flow.cylc  meta  opt
README_cylc8  rose-suite.conf  rose-suite.info  site  tests.cylc

Warning

“Other” means your own machine, or a system run by another institution (see Choosing your platform). This step cannot be completed there without local equivalents of the Met Office services it depends on: a supported LFRic build environment, repository access, shared ancillary data, and an HPC batch queue. The commands below are given so you can follow along and adapt them to your site, not because they will work unchanged.

$ cd ~/roses/<suite-id>
$ ls
app  flow.cylc  meta  opt
README_cylc8  rose-suite.conf  rose-suite.info  site  tests.cylc

Then run the rose edit command:

Running graphical applications over SSH

If you are connected to a remote system over SSH, graphical applications need X11 forwarding to display on your computer. Start an X server on your computer first (for example, XQuartz on macOS), then connect from a terminal using generic host details supplied by your service:

ssh -AY <remote-host>

Repeat the options for every additional SSH hop. The -Y option enables trusted X11 forwarding. The -A option forwards your SSH authentication agent and should only be used with systems you trust. A terminal integrated into an editor such as VS Code works in the same way as any other terminal.

On the system where you will start the graphical application, run echo "$DISPLAY". It should return a value. If it is blank, disconnect and reconnect with X11 forwarding enabled at every hop before continuing.

rose edit &

See also

For help choosing the correct Monsoon3 service and finding the official setup guidance, see Using Monsoon3.

rose edit &

Note

You must be on the Cylc host to run rose edit. It is not available on the compute nodes. X11 forwarding must be enabled on every hop, including the lander and the Cylc host.

Note

“Other” means your own machine, or a system run by another institution. You provide the environment yourself. See Choosing your platform.

rose edit &
What does the rose edit & command do?

  • This command opens the suite in the Rose graphical user interface, allowing you to view and modify its configuration.

  • The & at the end runs the GUI in the background, so your terminal remains available for other commands.

This will open up the Rose Graphical User Interface (GUI) for editing the workflow. You can navigate through the different sections using the tabs at the left of the window.

For example, navigate to the suite info tab where you should find the metadata you entered when you copied the workflow. You can edit this information if you wish - make sure you save your changes before exiting the GUI!

Unless you are familiar with the file structure of a workflow, it is recommended to use the Rose GUI to make changes to the workflow. However, if you are familiar with the file structure, you can also edit the files directly using a text editor.

Change the run time#

To change the time settings, you need to first open the rose GUI. Next, navigate to the suite conf > template variables tab. Here you will find the runtime settings.

Let’s start by changing the run length of the model. The current setting is for a 20 year and 6 month run P20Y6M. Note: the format is P<years>Y<months>M<days>D. Change this so that the end date is 01-01-1990 00:00:00.

Change the resolution#

Next, let’s change the model resolution. Navigate to the suite conf > template variables tab. Here you will find the resolution settings. What are the current settings? Make sure you change the atmospheric horizontal resolution to C64 and the ocean resolution to eORCA1. Save your changes and exit the Rose GUI.

Running the edited workflow#

Now that you have made changes to the workflow, go to the next page to run your workflow and see the changes you have made in action!