Skip to content

Commit 660c578

Browse files
headmetalatteggiani
authored andcommitted
Update run-access-issm.md
- Updated ISSM description - Updated required python version - Added more information about required projects -
1 parent 3597d39 commit 660c578

1 file changed

Lines changed: 30 additions & 12 deletions

File tree

docs/models/run_a_model/run-access-issm.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,44 @@
2020

2121
## 1 About
2222

23-
{{ model }} couples the **Ice-Sheet and Sea-Level System Model (ISSM)** to the ACCESS infrastructure, enabling fully parallel Antarctic and Greenland ice‑sheet simulations on the [NCI _Gadi_ supercomputer][gadi].
23+
{{ model }} integrates the **Ice-sheet and Sea-level System Model (ISSM)** to the ACCESS climate modelling framework, enabling fully parallel ice‑sheet simulations on the [NCI _Gadi_ supercomputer][gadi].
2424

2525
It is maintained and supported by **ACCESS‑NRI**.
26-
A high‑level description of model componentsincluding the ISSM core, pre‑processing utilities, climate forcings, and coupling hooks—is available in the [{{ model }} overview]({{ model_configurations }}/#{{ model }}).
26+
A high‑level description of model components including the ISSM core, pre‑processing utilities and forcing data are available in the [{{ model }} overview]({{ model_configurations }}/#{{ model }}).
2727

28-
The example below reproduces the *MISMIP+* benchmark. Adjust the variables to suit your experiment.
28+
The example below reproduces the ISSM controbution to the third [Marine Ice Sheet Model Intercomparison Project](https://tc.copernicus.org/articles/14/2283/2020/) (MISMIP+) benchmark for ice flow models.
2929

3030
## 2 Prerequisites
3131

32-
1. **NCI login + Gadi project** – request `access` and `vk83` memberships if you do not already have them.
33-
2. **Spack ISSM environment** – follow the build recipe in [https://github.com/ACCESS-NRI/access-issm](https://github.com/ACCESS-NRI/access-issm). You should end up with `ISSM_DIR` and a Spack `issm-env`.
34-
3. **Modules** – at minimum:
32+
!!! warning
33+
To run {{ model }}, you need to be a member of a project with allocated _Service Units (SU)_. For more information, check [how to join relevant NCI projects](/getting_started/set_up_nci_account#join-relevant-nci-projects).
34+
35+
- **NCI Account**<br>
36+
Before running {{ model }}, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account).
37+
38+
- **Join NCI projects**<br>
39+
Join the following projects by requesting membership on their respective NCI project pages:
40+
41+
- [vk83](https://my.nci.org.au/mancini/project/vk83/join)
42+
- [xp65](https://my.nci.org.au/mancini/project/xp65/join)
43+
44+
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).
45+
46+
- **Modules**
47+
48+
Load the following modules:
49+
3550
```bash
36-
module load python3/3.10.4 # matches the version used for ISSM Python API
51+
module load python3/3.9.2 #3.10.4
3752
module load git
3853
```
3954

4055
---
4156

4257
## 3  Quick‑start (Gadi login node)
4358

59+
To run he model, a NCI project code with available compute allocation is required.
60+
4461
```bash
4562
# 0. Choose a working directory for this test
4663
$ mkdir -p ~/experiments/mismip && cd ~/experiments/mismip
@@ -51,12 +68,13 @@ $ git clone --branch justinh2002/configuration \
5168

5269
# 2. Load the ACCESS-ISSM module (vk83 deployment)
5370
$ module use /g/data/vk83/modules
54-
$ module avail access-issm
5571
$ module load access-issm
5672

5773
# 3. Pre-process (mesh + inputs)
58-
$ cp access-issm/examples/mismip/run_pps.sh ./
59-
$ qsub run_pps.sh # or `bash run_pps.sh` inside a pInteractive job
74+
$ cp access-issm/test/run_pps.sh ./
75+
$ qsub -P <NCI_PROJECT_CODE> run_pps.sh
76+
# Alternatively use `bash run_pps.sh` inside a pInteractive job.
77+
# Replace "<NCI_PROJECT_CODE>" with your active project code.
6078

6179
# 4. When PPS finishes, run the first experiment bundle
6280
$ cp access-issm/examples/mismip/run_mismip_first.sh ./
@@ -131,7 +149,7 @@ $ python mismip_driver.py # uses default steps list
131149
### {{ model }} configuration
132150

133151
Key configurable groups (edit the configuration files as needed):
134-
152+
135153
| Suite | Section | Purpose |
136154
|-------|--------------------|----------------------------------------------------------------------|
137155
| **PPS** | Domain setup | Projection, bounds, resolution, MUA/SSA blend law, etc. |
@@ -158,4 +176,4 @@ Ask questions in the [ACCESS‑ISSM category](https://forum.access-hive.org.au/c
158176
- ISSM User Guide: https://issm.jpl.nasa.gov/documentation
159177
- ACCESS‑NRI ISSM build recipe: https://github.com/ACCESS-NRI/access-issm
160178
- NCI Cylc docs: https://opus.nci.org.au/display/DAE/Run+Cylc7+Suites
161-
</custom-references>
179+
</custom-references>

0 commit comments

Comments
 (0)