Skip to content

Commit 3d272b6

Browse files
committed
Merge branch 'development' into chrisb/om2_restart_workflow_update
2 parents abf7e9e + 3d0222f commit 3d272b6

13 files changed

Lines changed: 613 additions & 92 deletions

File tree

docs/assets/model-config-logos/model_visualisation/access_om_model_visualisation.png renamed to docs/assets/model-config-logos/model_visualisation/access_om2_model_visualisation.png

File renamed without changes.
16.4 MB
Loading
Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[cosima]: https://cosima.org.au/
12

23
# ACCESS-OM
34

@@ -6,11 +7,45 @@
67
The ACCESS Ocean Model (ACCESS-OM) is a global coupled ocean model that includes [ocean](/models/model_components/ocean), [ocean biogeochemistry](/models/model_components/bgc_ocean), and [sea ice](/models/model_components/sea-ice) components, linked together by a [coupler](/models/model_components/coupler).<br>
78
The atmospheric fields that drive the model are provided by a data source, usually derived from reanalysis.
89

9-
## ACCESS-OM2
10+
{% set model = "ACCESS-OM3" %}
11+
## {{ model }}
1012

11-
[ACCESS-OM2](https://gmd.copernicus.org/articles/13/401/2020/) [@Kiss2020] [@ACCESS-OM2-report] [@Solodoch2022] [@Hayashida2023] [@Menviel2023] is a suite of coupled ocean-sea ice models originally developed by the [Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA)](http://cosima.org.au/).<br>
13+
{{ model }} is a suite of coupled ocean-sea ice models developed by ACCESS-NRI and the [Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA)][cosima].
1214

13-
ACCESS-NRI has released [ACCESS-OM2 configurations](https://github.com/ACCESS-NRI/access-om2-configs) as an adaptation of those originally developed by COSIMA.
15+
ACCESS-NRI has released [{{ model }} configurations](https://github.com/ACCESS-NRI/access-om3-configs).
16+
17+
There is a global configuration for **one spatial resolution**:
18+
19+
- 0.25° or 25km horizontal resolution, 75 vertical levels.
20+
21+
For the above resolution there is **one option of JRA55-do atmospheric forcing**:
22+
23+
- Repeat Year Forcing (RYF): repeated 1 May 1990 - 30 April 1991 forcing
24+
25+
Each configuration also has an optional biogeochemical (BGC) configuration that uses the [Biogeochemistry Ocean component](/models/model_components/bgc_ocean), if required.
26+
!!! warning
27+
BGC experiments are slower and generally consume more resources (compute time and disk space).
28+
29+
### Model Components {: #model-components-{{model}} }
30+
31+
- **Ocean**: [MOM6](/models/model_components/ocean#mom6).<br>
32+
Tripolar grid.
33+
34+
- **Sea ice**: [CICE6](/models/model_components/sea-ice#cice6).<br>
35+
Same grid as ocean.
36+
37+
- **Ocean Biogeochemistry**: [WOMBAT](/models/model_components/bgc_ocean#wombat) (optional).
38+
39+
- **Coupler**: [NUOPC](/models/model_components/coupler#nuopc).
40+
41+
[Run {{ model }}](/models/run-a-model/run-access-om3){: class="text-card"}
42+
43+
{% set model = "ACCESS-OM2" %}
44+
## {{ model }}
45+
46+
[{{ model }}](https://gmd.copernicus.org/articles/13/401/2020/) [@Kiss2020] [@ACCESS-OM2-report] [@Solodoch2022] [@Hayashida2023] [@Menviel2023] is a suite of coupled ocean-sea ice models originally developed by the [Consortium for Ocean-Sea Ice Modelling in Australia (COSIMA)][cosima].<br>
47+
48+
ACCESS-NRI has released [{{ model }} configurations](https://github.com/ACCESS-NRI/access-om2-configs) as an adaptation of those originally developed by COSIMA.
1449

1550
There are global configurations for **three spatial resolutions**:
1651

@@ -21,21 +56,21 @@ There are global configurations for **three spatial resolutions**:
2156
For each resolution there are **two options of JRA55-do atmospheric forcing**:
2257

2358
- Repeat Year Forcing (RYF): repeated 1 May 1990 - 30 April 1991 forcing
24-
- Interannual Forcing (IAF): 1958-2018 forcing
59+
- Inter-Annual Forcing (IAF): 1958-2018 forcing
2560

2661
Each configuration also has an optional biogeochemical (BGC) configuration that uses the [Biogeochemistry Ocean component](/models/model_components/bgc_ocean), if required.
2762
!!! warning
2863
BGC experiments are slower and generally consume more resources (compute time and disk space).
2964

30-
### Model Components
65+
### Model Components {: #model-components-{{model}} }
3166
<div class="tabLabels" label="ACCESS-OM2-versions">
32-
<button id="1deg">ACCESS-OM2</button>
33-
<button id="025deg">ACCESS-OM2-025</button>
34-
<button id='01deg'>ACCESS-OM2-01</button>
67+
<button id="{{ model }}-1deg">{{ model }}-1</button>
68+
<button id="{{ model }}-025deg">{{ model }}-025</button>
69+
<button id='{{ model }}-01deg'>{{ model }}-01</button>
3570
</div>
3671

3772
- **Ocean**: [MOM5](/models/model_components/ocean#mom5).<br>
38-
Tripolar grid, <span tabcontentfor="1deg">1</span><span tabcontentfor="025deg">0.25</span><span tabcontentfor="01deg">0.1</span>° spatial resolution, <span tabcontentfor="1deg">50</span><span tabcontentfor="025deg">50</span><span tabcontentfor="01deg">75</span> vertical levels.
73+
Tripolar grid, <span tabcontentfor="{{ model }}-1deg">1</span><span tabcontentfor="{{ model }}-025deg">0.25</span><span tabcontentfor="{{ model }}-01deg">0.1</span>° spatial resolution, <span tabcontentfor="{{ model }}-1deg">50</span><span tabcontentfor="{{ model }}-025deg">50</span><span tabcontentfor="{{ model }}-01deg">75</span> vertical levels.
3974

4075
- **Ocean Biogeochemistry**: [WOMBAT](/models/model_components/bgc_ocean#wombat) (optional).
4176

@@ -46,6 +81,6 @@ Each configuration also has an optional biogeochemical (BGC) configuration that
4681

4782
More details on the models can be found in [this ACCESS-Hive Forum post](https://forum.access-hive.org.au/t/access-om2-control-experiments/258), together with details on the extensive control experiment data already available without needing to run a new experiment.
4883

49-
Full conditions of use for ACCESS-OM2 models and outputs can be viewed in the [ACCESS-OM2-configs README](https://github.com/ACCESS-NRI/access-om2-configs?tab=readme-ov-file#conditions-of-use).
84+
Full conditions of use for {{ model }} models and outputs can be viewed in the [{{ model }}-configs README](https://github.com/ACCESS-NRI/access-om2-configs?tab=readme-ov-file#conditions-of-use).
5085

51-
[Run ACCESS-OM2](/models/run-a-model/run-access-om){: class="text-card"}
86+
[Run {{ model }}](/models/run-a-model/run-access-om2){: class="text-card"}

docs/models/model_components/ocean.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ There are two MOM versions currently used in ACCESS models: [MOM5](https://githu
2020
- [ACCESS-OM2](/models/configurations/access-om#access-om2)
2121
</div>
2222
<div tabcontentfor="mom6" markdown>
23-
MOM6 is not yet included in any ACCESS-NRI-supported configuration, but will be included in ACCESS-OM3, a configuration currently under development.
24-
</div>
23+
- [ACCESS-OM3](/models/configurations/access-om#access-om3)
24+
</div>

docs/models/model_components/sea-ice.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ There are three CICE versions currently used in ACCESS models:
2323
- [ACCESS-OM2](/models/configurations/access-om#access-om2)
2424
</div>
2525
<div tabcontentfor="cice6" markdown>
26-
CICE6 is not yet included in any ACCESS-NRI-supported configuration, but will be included in ACCESS-OM3, a configuration currently under development.
27-
</div>
26+
- [ACCESS-OM3](/models/configurations/access-cm#access-om3)
27+
</div>

docs/models/run-a-model/index.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,22 @@ If you are unsure which ACCESS model is the right choice for your experiment, ta
2222
Run ACCESS-ESM
2323
</div>
2424
</a>
25-
<!-- Run ACCESS-OM -->
26-
<a href="/models/run-a-model/run-access-om" class="vertical-card aspect-ratio1to1">
25+
<!-- Run ACCESS-OM2 -->
26+
<a href="/models/run-a-model/run-access-om2" class="vertical-card aspect-ratio1to1">
2727
<div class="card-image-container">
28-
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/model_visualisation/access_om_model_visualisation.png" alt="ACCESS-OM">
28+
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/model_visualisation/access_om2_model_visualisation.png" alt="ACCESS-OM2">
2929
</div>
3030
<div class="card-text-container bold">
31-
Run ACCESS-OM
31+
Run ACCESS-OM2
32+
</div>
33+
</a>
34+
<!-- Run ACCESS-OM3 -->
35+
<a href="/models/run-a-model/run-access-om3" class="vertical-card aspect-ratio1to1">
36+
<div class="card-image-container">
37+
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/model_visualisation/access_om3_model_visualisation.png" alt="ACCESS-OM3">
38+
</div>
39+
<div class="card-text-container bold">
40+
Run ACCESS-OM3
3241
</div>
3342
</a>
3443
<!-- Run ACCESS-rAM -->

docs/models/run-a-model/run-access-cm.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,31 @@
1010

1111
## Prerequisites
1212

13-
### General prerequisites
14-
15-
Before running {{ model }}, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account).
16-
17-
If you are unsure whether {{ model }} is the right choice for your experiment, take a look at the overview of [ACCESS Models](/models).
18-
19-
### Model-specific prerequisites
13+
- **NCI Account**<br>
14+
Before running {{ model }}, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account).
2015

2116
- **_MOSRS_ account**<br>
2217
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)).<br>
2318
To apply for a _MOSRS_ account, please contact your [local institutional sponsor](https://opus.nci.org.au/display/DAE/Prerequisites).
19+
{: #mosrs-account}
2420

25-
- **Join the _access_, _hr22_, _ki32_ and _ki32\_mosrs_ projects at NCI**<br>
26-
To join these projects, request membership on the respective [access](https://my.nci.org.au/mancini/project/access/join), [hr22](https://my.nci.org.au/mancini/project/hr22/join), [ki32](https://my.nci.org.au/mancini/project/ki32/join) and [ki32_mosrs](https://my.nci.org.au/mancini/project/ki32_mosrs/join) NCI project pages.
21+
- **Join NCI projects**<br>
22+
Join the following projects by requesting membership on their respective NCI project pages:
2723

28-
!!! tip
29-
To request membership for the _ki32_mosrs_ subproject you need to have a MOSRS account and be member of the _ki32_ project.
24+
- [access](https://my.nci.org.au/mancini/project/access/join)
25+
- [hr22](https://my.nci.org.au/mancini/project/hr22/join)
26+
- [ki32](https://my.nci.org.au/mancini/project/ki32/join)
27+
- [ki32_mosrs](https://my.nci.org.au/mancini/project/ki32_mosrs/join)
3028

31-
For more information on how to join specific NCI projects, refer to [How to connect to a project](https://opus.nci.org.au/display/Help/How+to+connect+to+a+project).
29+
!!! tip
30+
To request membership for the _ki32_mosrs_ subproject, you need to:
31+
32+
- already be member of the _ki32_ project
33+
{: style="list-style-type: disc"}
34+
- have a [MOSRS account](#mosrs-account)
35+
{: style="list-style-type: disc"}
36+
37+
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).
3238

3339
- **Connection to an ARE VDI Desktop (optional)**<br>
3440
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.<br>
@@ -380,13 +386,13 @@ rose suite-gcontrol
380386
It is quite common, especially during the first few runs, to experience errors and job failures. Running an {{ model }} suite involves the execution of several tasks, and any of these tasks could fail. When a task fails, the suite is halted and a red icon appears next to the respective task name in the _Cylc_ GUI.<br>
381387
To investigate the cause of a failure, we need to look at the logs `job.err` and `job.out` from the suite run. There are two main ways to do so:
382388
383-
#### Using the _Cylc_ GUI
389+
#### Using the _Cylc_ GUI {: .no-toc }
384390
Right-click on the task that failed and click on _View Job Logs (Viewer) &rarr; job.err_ (or _job.out_).<br>
385391
To access a specific task, click on the arrow next to the task to extend the drop-down menu with all the subtasks.
386392
387393
![Investigate Error GUI example](/assets/run_access_cm/investigate_error_gui_are.gif){: class="example-img" loading="lazy"}
388394
389-
#### Through the suite directory
395+
#### Through the suite directory {: .no-toc }
390396
The suite's log directories are stored in `~/cylc-run/<suite-ID>` as `log.<TIMESTAMP>`, and the latest set of logs are also symlinked in the `~/cylc-run/<suite-ID>/log` directory.<br>
391397
The logs for the main job can be found in the `~/cylc-run/<suite-ID>/log/job` directory.<br>
392398
Logs are separated into simulation cycles according to their starting dates, then divided into subdirectories according to the task name. They are then further separated into "attempts" (consecutive failed/successful tasks), where `NN` is a symlink to the most recent attempt.
@@ -457,7 +463,7 @@ qdel <job-ID>
457463
### RESTART a suite
458464
There are two main ways to restart a suite:
459465
460-
#### _SOFT_ restart
466+
#### _SOFT_ restart {: .no-toc }
461467
To reinstall the suite and reopen _Cylc_ in the same state it was prior to being stopped, run the following command from within the suite directory:
462468
```
463469
rose suite-run --restart
@@ -504,7 +510,7 @@ rose suite-run --restart
504510
<img src="/assets/run_access_cm/Cylc_GUI_are.png" alt="Cylc GUI" imageTime="inf" loading="lazy">
505511
</terminal-window>
506512
507-
#### _HARD_ restart
513+
#### _HARD_ restart {: .no-toc }
508514
To overwrite any previous runs of the suite and start afresh, run the following command from within the suite directory:
509515
```
510516
rose suite-run --new

0 commit comments

Comments
 (0)