From ddf63cd81536125fd6f774340b4bbb1960c7f14e Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 19 May 2026 09:39:42 +1000 Subject: [PATCH 1/9] test include-markdown --- .../run_a_model => includes}/rose_cylc.md | 4 + docs/models/run_a_model/run_access-cm2.md | 73 ++----------------- mkdocs.yml | 1 + 3 files changed, 10 insertions(+), 68 deletions(-) rename docs/{models/run_a_model => includes}/rose_cylc.md (99%) diff --git a/docs/models/run_a_model/rose_cylc.md b/docs/includes/rose_cylc.md similarity index 99% rename from docs/models/run_a_model/rose_cylc.md rename to docs/includes/rose_cylc.md index 3727f4dbf..1804f18db 100644 --- a/docs/models/run_a_model/rose_cylc.md +++ b/docs/includes/rose_cylc.md @@ -81,6 +81,8 @@ Once the new tab opens, you will see a Desktop with a few folders on the left. C ## Set up a persistent session + + NCI provides a service called [_persistent sessions_](https://opus.nci.org.au/spaces/Help/pages/241926895/Persistent+Sessions) to enable long running processes, like _Cylc_, to stay active even when the user disconnects from _Gadi_. It is recommended to have only one active persistent session at any given time, as multiple _Cylc_ sessions can use the same persistent session. @@ -163,6 +165,8 @@ persistent-sessions kill !!! warning When you terminate a _persistent session_, any model running on that session will stop. Therefore, you should check whether you have any active model runs before terminating a _persistent session_. + + ## Set up Rose/Cylc ### Rose and Cylc executables diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index 476c8f489..3f3182458 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -81,78 +81,15 @@ To open the terminal, click on the black terminal icon at the top of the window. ![Open ARE VDI terminal example](/assets/run_access_cm/open_are_vdi_terminal.gif){: class="example-img" loading="lazy"} ## Set up {{ model }} persistent session -To support the use of long-running processes, such as ACCESS model runs, NCI provides a service on _Gadi_ called [persistent sessions](https://opus.nci.org.au/display/Help/Persistent+Sessions). -To run {{ model }}, you need to start a persistent session and set it as the target session for the model run. +{% + include-markdown "docs/includes/rose_cylc.md" + start="" + end="" +%} -### Start a new persistent session -To start a new persistent session on _Gadi_, using either a login node or an ARE terminal instance, run the following command: -``` -persistent-sessions start -``` - -This will start a persistent session with the given `name` that runs under your [default project](/getting_started/set_up_nci_account#change-default-project-on-gadi).
-If you want to assign a different project to the persistent session, use the option `-p`: -``` -persistent-sessions start -p -``` - -!!! tip - While the project assigned to a persistent session does not have to be the same as the project used to run the {{ model }} configuration, it does need to have allocated _Service Units (SU)_.
- For more information, check how to [Join relevant NCI projects](/getting_started/set_up_nci_account#join-relevant-nci-projects). - - - persistent-sessions start <name> - session <persistent-session-uuid> running - connect using -  ssh <name>.<$USER>.<project>.ps.gadi.nci.org.au - - -To list all active persistent sessions run: -``` -persistent-sessions list -``` - - - persistent-sessions list -              UUID  PROJECT   ADDRESS    CPUTIME MEMORY - <persistent-session-uuid> <project> 10.9.0.62 00:00:05.213 30.5M - -The label of a newly-created persistent session has the following format:
-`.<$USER>..ps.gadi.nci.org.au`. - -### Specify {{ model }} target persistent session - -After starting the persistent session, it is essential to assign it to the {{ model }} run.
-The easiest way to do this is to insert the persistent session label into the file `~/.persistent-sessions/cylc-session`.
-You can do it manually, or by running the following command (by substituting `` with the name given to the persistent session, and `` with the project assigned to it): -``` -cat > ~/.persistent-sessions/cylc-session <<< ".${USER}..ps.gadi.nci.org.au" -``` - -For example, if the user `abc123` started a persistent session named `cylc` under the project `xy00`, the command will be: - - - cat > ~/.persistent-sessions/cylc-session <<< cylc.abc123.xy00.ps.gadi.nci.org.au - cat ~/.persistent-sessions/cylc-session - cylc.abc123.xy00.ps.gadi.nci.org.au - - -For more information on how to specify the target session, refer to [Specify Target Session with Cylc7 Suites](https://opus.nci.org.au/display/DAE/Run+Cylc7+Suites#RunCylc7Suites-SpecifyTargetSession). - -!!! tip - You can simultaneously submit multiple {{ model }} runs using the same persistent session without needing to start a new one. Hence, the process of specifying the target persistent session for {{ model }} should only be done once.
- After specifying the {{ model }} target persistent session the first time, to run {{ model }} you just need to make sure to have an active persistent session named like the specified {{ model }} target persistent session. - -### Terminate a persistent session -To stop a persistent session, run: -``` -persistent-sessions kill -``` -!!! warning - When you terminate a persistent session, any model running on that session will stop. Therefore, you should check whether you have any active model runs before terminating a persistent session. - ## Rose/Cylc/MOSRS setup To run {{ model }}, access to multiple software and MOSRS authentication is needed. diff --git a/mkdocs.yml b/mkdocs.yml index c47b1bddf..f9ecc7f51 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -70,6 +70,7 @@ plugins: 'models/run_a_model/run_access-ram.md': 'models/run_a_model/run_access-ram3.md' - resolve-absolute-urls - macros + - include-markdown # Extensions markdown_extensions: From 1a938986e589b8a20613a215317f45a599fb1dba Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 19 May 2026 10:01:06 +1000 Subject: [PATCH 2/9] install plugin --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 6a90cd947..623ea21aa 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,4 @@ mkdocs-macros-plugin==1.3.7 mkdocs-bibtex==4.4.0 git+https://github.com/ACCESS-NRI/mkdocs_resolve_absolute_urls_plugin.git@1.3.0 mkdocs-redirects==1.2.2 +mkdocs-include-markdown-plugin From 33ab184ee6dc69b695586ff84b31cedf555bb0cd Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 19 May 2026 10:19:54 +1000 Subject: [PATCH 3/9] update includes path --- docs/models/run_a_model/run_access-cm2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index 3f3182458..fdba6e3ad 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -83,7 +83,7 @@ To open the terminal, click on the black terminal icon at the top of the window. ## Set up {{ model }} persistent session {% - include-markdown "docs/includes/rose_cylc.md" + include-markdown "/docs/includes/rose_cylc.md" start="" end="" %} From c6c02458e90f9c33dae7a35765cb261cb2f7a848 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 19 May 2026 10:29:00 +1000 Subject: [PATCH 4/9] update includes path again --- docs/models/run_a_model/run_access-cm2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index fdba6e3ad..9a2f90002 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -83,7 +83,7 @@ To open the terminal, click on the black terminal icon at the top of the window. ## Set up {{ model }} persistent session {% - include-markdown "/docs/includes/rose_cylc.md" + include-markdown "includes/rose_cylc.md" start="" end="" %} From b3aadf4d1e47a10b43bdd904c7e568a1489f0116 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 19 May 2026 10:50:44 +1000 Subject: [PATCH 5/9] add model name variable for testing --- docs/includes/rose_cylc.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/includes/rose_cylc.md b/docs/includes/rose_cylc.md index 1804f18db..5e77603fe 100644 --- a/docs/includes/rose_cylc.md +++ b/docs/includes/rose_cylc.md @@ -85,6 +85,8 @@ Once the new tab opens, you will see a Desktop with a few folders on the left. C NCI provides a service called [_persistent sessions_](https://opus.nci.org.au/spaces/Help/pages/241926895/Persistent+Sessions) to enable long running processes, like _Cylc_, to stay active even when the user disconnects from _Gadi_. +You will need to start a persistent session in order to run {{ model }}. + It is recommended to have only one active persistent session at any given time, as multiple _Cylc_ sessions can use the same persistent session. Note that persistent sessions are terminated during the quarterly maintenance at NCI and will need to be restarted afterwards. The new persistent session can be given the same name as used previously. From 40f20f738b600b78e4cbeefb200311fc81189635 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 26 May 2026 10:00:18 +1000 Subject: [PATCH 6/9] add more includes sections into run cm2 --- docs/includes/rose_cylc.md | 12 +++++ docs/models/access_models/access-cm.md | 4 ++ docs/models/run_a_model/run_access-cm2.md | 65 ++++++++++------------- 3 files changed, 43 insertions(+), 38 deletions(-) diff --git a/docs/includes/rose_cylc.md b/docs/includes/rose_cylc.md index 5e77603fe..a7157b410 100644 --- a/docs/includes/rose_cylc.md +++ b/docs/includes/rose_cylc.md @@ -16,6 +16,8 @@ A set of tasks configured by _Rose_ to run with the _Cylc7_ engine is called a _ ## Prerequisites + + - **NCI account**
Before running an ACCESS model, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account). @@ -27,6 +29,8 @@ A set of tasks configured by _Rose_ to run with the _Cylc7_ engine is called a _ !!! warning The waiting time to obtain a MOSRS account can be up to 3 weeks. + + - **Join NCI projects**
Join the following projects by requesting membership on their respective NCI project pages: @@ -36,6 +40,8 @@ A set of tasks configured by _Rose_ to run with the _Cylc7_ engine is called a _ ## Connecting to Gadi + + You can run _Rose/Cylc_ either from a [_Gadi_ login node](#connect-via-gadi-login-node) or via an [ARE VDI session](#launch-are-vdi-desktop). ### Connect via Gadi login node @@ -65,9 +71,13 @@ Go to the [ARE VDI](https://are.nci.org.au/pun/sys/dashboard/batch_connect/sys/d - **Project** → a project of which you are a member.
The project must have allocated [_Service Units (SU)_](https://opus.nci.org.au/spaces/Help/pages/236881132/Allocations...). By default, this will be set to your default project `$PROJECT`. + + - **Storage** → `gdata/hr22+scratch/$PROJECT` (minimum)
The storage folders listed above are the minimum required to run _Rose/Cylc_. + + Launch the ARE session and, once it starts, click on _Launch VDI Desktop_. ![Launch ARE VDI session example](/assets/run_access_cm/launch_are_vdi.gif){: class="example-img" loading="lazy"} @@ -78,6 +88,8 @@ Once the new tab opens, you will see a Desktop with a few folders on the left. C ![Open ARE VDI terminal example](/assets/run_access_cm/open_are_vdi_terminal.gif){: class="example-img" loading="lazy"} + + ## Set up a persistent session diff --git a/docs/models/access_models/access-cm.md b/docs/models/access_models/access-cm.md index a6d7d0001..95eda1164 100644 --- a/docs/models/access_models/access-cm.md +++ b/docs/models/access_models/access-cm.md @@ -2,9 +2,13 @@ ![ACCESS CM model](/assets/model-config-logos/configurations-without-titles/access-cm.png){: class="img-contain white-background round-edges with-padding intro-img" loading="lazy"} + + The ACCESS Coupled Model (ACCESS-CM) is a fully-coupled global climate model that includes [atmosphere](/models/model_components/atmosphere), [aerosols and atmospheric chemistry](/models/model_components/aerosols_atmospheric_chemistry), [land](/models/model_components/land), [ocean](/models/model_components/ocean) and [sea ice](/models/model_components/sea-ice) components, linked together by a [coupler](/models/model_components/coupler).
It produces physical climate simulations. + + {% set model = "ACCESS-CM2" %} ## {{ model }} diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index 9a2f90002..b51d29067 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -12,15 +12,24 @@ If you were an _accessdev_ user, make sure you are a member of [hr22](https://my.nci.org.au/mancini/project/hr22/join) and [ki32](https://my.nci.org.au/mancini/project/ki32/join) projects.
Then, refer to instructions on how to [Set up persistent session workflow for {{ model }}]({{ '#set-up-%s-persistent-session'%model.lower() }}), and how to [port suites from accessdev](#port-suites-from-accessdev). -## Prerequisites +## About + +{% + include-markdown "models/access_models/access-cm.md" + start="" + end="" +%} +A full description of the model and its components is available in the [{{ model }} overview]({{ access_models }}/#{{ model }}). + +{{ model }} is run using the Rose/Cylc workflow management tool on the Gadi supercomputer. Follow the steps below to set up and run the model. -- **NCI Account**
- Before running {{ model }}, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account). +## Prerequisites -- **_MOSRS_ account**
- The [Met Office Science Repository Service (MOSRS)](https://code.metoffice.gov.uk) is a server run by the UK Met Office (UKMO) to support collaborative development with other partners organisations. MOSRS contains the source code and configurations for some model components in {{ model }} (e.g., the [UM](/models/model_components/atmosphere/#unified-model-um)).
- To apply for a _MOSRS_ account, please contact your [local institutional sponsor](https://opus.nci.org.au/display/DAE/Prerequisites). - {: #mosrs-account} +{% + include-markdown "includes/rose_cylc.md" + start="" + end="" +%} - **Join NCI projects**
Join the following projects by requesting membership on their respective NCI project pages: @@ -41,44 +50,24 @@ For more information on joining specific NCI projects, refer to [How to connect to a project](https://opus.nci.org.au/display/Help/How+to+connect+to+a+project). -- **Connection to an ARE VDI Desktop (optional)**
- To run {{ model }}, start an [Australian Research Environment (ARE) VDI Desktop](https://are.nci.org.au/pun/sys/dashboard/batch_connect/sys/desktop_vnc/ncigadi/session_contexts/new) session.
- If you are not familiar with ARE, check out the [Getting Started on ARE](/getting_started/are) section. +## Connecting to Gadi -## Set up an ARE VDI Desktop (optional) -To skip this step and instead run {{ model }} from _Gadi_ login node, refer to instructions on how to [Set up {{ model }} persistent session]({{ '#set-up-%s-persistent-session'%model.lower() }}). - -### Launch ARE VDI Session -Go to the [ARE VDI](https://are.nci.org.au/pun/sys/dashboard/batch_connect/sys/desktop_vnc/ncigadi/session_contexts/new) page and launch a session with the following entries: - -- **Walltime (hours)** → `2`
- This is the amount of time the ARE VDI session will stay active for.
- {{ model }} does not run directly on ARE.
- This means that the ARE VDI session only needs to carry out setup steps as well as starting the run itself. All these tasks can be done within 2 hours. - -- **Queue** → `normalbw` - -- **Compute Size** → `tiny` (1 CPU)
- As mentioned above, the ARE VDI session is only needed for setup and startup tasks, which can be easily accomplished with 1 CPU. - -- **Project** → a project of which you are a member.
- The project must have allocated _Service Units (SU)_ to run your simulation. Usually, but not always, this corresponds to your `$PROJECT`.
- For more information, refer to how to [Join relevant NCI projects](/getting_started/set_up_nci_account#join-relevant-nci-projects). +{% + include-markdown "includes/rose_cylc.md" + start="" + end="" +%} - **Storage** → `gdata/access+gdata/xp65+gdata/hr22+gdata/ki32` (minimum)
This is a list of all project data storage, joined by plus (`+`) signs, needed for the {{ model }} simulation. In ARE, storage locations need to be explicitly defined to access data from within a VDI instance.
Every {{ model }} simulation can be unique and input data can originate from various sources. Hence, if your simulation requires data stored in project folders other than `access`, `xp65`, `hr22` or `ki32`, you need to add those projects to the storage path.
For example, if your {{ model }} simulation requires data stored in `/g/data/tm70` and `/scratch/w40`, your full storage path will be: `gdata/access+gdata/xp65+gdata/hr22+gdata/ki32+gdata/tm70+scratch/w40` - -Launch the ARE session and, once it starts, click on _Launch VDI Desktop_. -![Launch ARE VDI session example](/assets/run_access_cm/launch_are_vdi.gif){: class="example-img" loading="lazy"} - -### Open the terminal in the VDI Desktop -Once the new tab opens, you will see a Desktop with a few folders on the left.
-To open the terminal, click on the black terminal icon at the top of the window. You should now be connected to a _Gadi_ computing node. - -![Open ARE VDI terminal example](/assets/run_access_cm/open_are_vdi_terminal.gif){: class="example-img" loading="lazy"} +{% + include-markdown "includes/rose_cylc.md" + start="" + end="" +%} ## Set up {{ model }} persistent session From 714b64b4a7a10bc5f3655ef51580107508b7cc1a Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 26 May 2026 10:16:28 +1000 Subject: [PATCH 7/9] tweak wording --- docs/models/run_a_model/run_access-cm2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index b51d29067..58db47a8f 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -21,7 +21,7 @@ %} A full description of the model and its components is available in the [{{ model }} overview]({{ access_models }}/#{{ model }}). -{{ model }} is run using the Rose/Cylc workflow management tool on the Gadi supercomputer. Follow the steps below to set up and run the model. +{{ model }} runs using the Rose/Cylc workflow management tool on the Gadi supercomputer. Follow the steps below to set up and run the model. ## Prerequisites From bca5395cc04d76ad5041fe2ba2f6e65882d701cd Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 26 May 2026 10:42:07 +1000 Subject: [PATCH 8/9] fix typo --- docs/models/run_a_model/run_access-cm2.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index a0c9c9325..245dc9677 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -27,8 +27,8 @@ A full description of the model and its components is available in the [{{ model {% include-markdown "includes/rose_cylc.md" - start="" - end="" + start="" + end="" %} - **Join NCI projects**
From 1764e80c044cdac1976514d279c84a367d3c6bb1 Mon Sep 17 00:00:00 2001 From: Paige Martin Date: Tue, 23 Jun 2026 09:22:06 +1000 Subject: [PATCH 9/9] add more includes sections --- docs/includes/rose_cylc.md | 26 +++++++++- docs/models/run_a_model/run_access-cm2.md | 59 ++++++++--------------- 2 files changed, 44 insertions(+), 41 deletions(-) diff --git a/docs/includes/rose_cylc.md b/docs/includes/rose_cylc.md index 0a96aa106..27611203c 100644 --- a/docs/includes/rose_cylc.md +++ b/docs/includes/rose_cylc.md @@ -8,11 +8,14 @@ ## About The _Rose/Cylc_ workflow management tool consists of two components: -* The [_Cylc_](https://niwa.co.nz/environmental-information/cylc-suite-engine) (pronounced ‘silk’) task engine, developed by the New Zealand National Institute of Water and Atmospheric Research (NIWA). Cylc is a workflow manager that automatically executes tasks according to the model's configuration. It also monitors all tasks, reporting any errors that may occur. -* The [_Rose_](https://www.metoffice.gov.uk/research/approach/modelling-systems/rose) framework developed by the UKMO which configures tasks for the _Cylc_ engine. Rose is a toolkit that can be used to view, edit and run some of the [ACCESS models](/models/access_models). + + +* The [_Cylc_](https://cylc.github.io/cylc-doc/7.8.8/html/index.html) (pronounced ‘silk’) task engine, developed by the New Zealand National Institute of Water and Atmospheric Research - NIWA (now Earth Sciences NZ). Cylc is a workflow manager that automatically executes tasks according to the model's configuration. _Cylc_ controls how the job will be run and manages the time steps of each model component. It also monitors all tasks, reporting any errors that may occur. +* The [_Rose_](https://metomi.github.io/rose/doc/html/index.html) framework, developed by the UKMO which configures tasks for the _Cylc_ engine. Rose is a toolkit that can be used to view, edit and run some of the [ACCESS models](/models/access_models). A set of tasks configured by _Rose_ to run with the _Cylc7_ engine is called a _suite_. Every _suite_ has a unique identifier called `suite-ID` in the form `u-LLNNN`, where `L` is a letter and `N` is a number (e.g., u-ab123). + ## Prerequisites @@ -183,8 +186,12 @@ persistent-sessions kill ## Set up Rose/Cylc + + ### Rose and Cylc executables + + Make the `rose` and `cylc` executables available by loading the _Cylc_ module: ``` @@ -192,8 +199,21 @@ module use /g/data/hr22/modulefiles module load cylc7 ``` + + module use /g/data/hr22/modulefiles + module load cylc7 + Using the cylc session <name>.<$USER>.<project>.ps.gadi.nci.org.au + + Loading cylc7/24.03 +  Loading requirement: mosrs-setup/2.0.1 + + + + ### MOSRS Authentication + + The ACCESS models which use _Cylc_ require a connection to the MOSRS mirror on _Gadi_. To connect to this mirror, you must first authenticate your MOSRS credentials with: ``` @@ -214,6 +234,8 @@ This will request the username and password you received when you created your M After the first authentication, you will need to run `mosrs-auth` every 24 hours and for every new connection to _Gadi_ (e.g., new terminal) to verify your password against the saved credentials. + + ## Get the model configuration Depending on the specific model, its configuration will be hosted either on _GitHub_ or MOSRS. The [Run a Model](/models/run_a_model/) documentation for the respective model will specify where the configuration is stored.
diff --git a/docs/models/run_a_model/run_access-cm2.md b/docs/models/run_a_model/run_access-cm2.md index 245dc9677..ff7ec31dc 100644 --- a/docs/models/run_a_model/run_access-cm2.md +++ b/docs/models/run_a_model/run_access-cm2.md @@ -79,55 +79,36 @@ A full description of the model and its components is available in the [{{ model -## Rose/Cylc/MOSRS setup +## Set up Rose/Cylc -To run {{ model }}, access to multiple software and MOSRS authentication is needed. +To run {{ model }}, you will use the Rose/Cylc workflow management tool, which consists of two components: -### Cylc setup {: #cylc } +{% + include-markdown "includes/rose_cylc.md" + start="" + end="" +%} -[_Cylc_](https://cylc.github.io/cylc-doc/7.8.8/html/index.html) (pronounced ‘silk’) is a workflow manager that automatically executes tasks according to the model's main cycle script `suite.rc`. _Cylc_ controls how the job will be run and manages the time steps of each model component. It also monitors all tasks, reporting any errors that may occur. +### Rose and Cylc executables + +{% + include-markdown "includes/rose_cylc.md" + start="" + end="" +%} -To get the _Cylc_ setup required to run {{ model }}, execute the following commands: -``` -module use /g/data/hr22/modulefiles -module load cylc7 -``` - - module use /g/data/hr22/modulefiles - module load cylc7 - Using the cylc session <name>.<$USER>.<project>.ps.gadi.nci.org.au - - Loading cylc7/24.03 -  Loading requirement: mosrs-setup/2.0.1 - !!! warning _Cylc_ version >= `cylc7/24.03` required.
- - Also, before loading the _Cylc_ module, make sure to have started a _persistent session_ and have assigned it to the {{ model }} workflow. For more information about these steps, refer to [Set up {{ model }} persistent session]({{ '#set-up-%s-persistent-session'%model.lower() }}). - -### Rose setup {: #rose } -[Rose](https://metomi.github.io/rose/doc/html/index.html) is a toolkit that can be used to view, edit, or run an ACCESS modelling suite. - -By completing the [_Cylc_ setup](#cylc), also _Rose_ will be automatically available. Hence, no additional step is required. + ### MOSRS authentication -To authenticate using your _MOSRS_ credentials, run: -``` -mosrs-auth -``` - - mosrs-auth - INFO: You need to enter your MOSRS credentials here so that GPG can cache your password. - Please enter the MOSRS password for <MOSRS-username>: - Checking your credentials using Subversion. Please wait. - INFO: Successfully accessed Subversion with your credentials. - INFO: Checking your credentials using rosie. Please wait. - INFO: Successfully accessed rosie with your credentials. - -!!! warning - This step needs to be done once for each new session (e.g., _Gadi_ login, _ARE_ terminal window) +{% + include-markdown "includes/rose_cylc.md" + start="" + end="" +%} ## Get {{ model }} suite {{ model }} comprises the model components [UM](/models/model_components/atmosphere#unified-model-um), [MOM](/models/model_components/ocean#modular-ocean-model-mom), [CICE](/models/model_components/sea-ice#cice) and [CABLE](/models/model_components/land#cable), coupled through [OASIS](/models/model_components/coupler#oasis3-mct). These components, which have different model parameters, input data and computer-related information, need to be packaged together as a _suite_ in order to run.