Added initial docs on running AM3. Fixes #993 #1000
Conversation
|
|
|
||
| If you are unsure whether {{ model }} is the right choice for your experiment, take a look at the overview of [ACCESS Models](/models). | ||
|
|
||
| [{{ model }} release notes]({{release_notes}}) are available on the ACCESS-Hive Forum and are updated when new releases are made available. |
There was a problem hiding this comment.
Remove for now because the release notes will only be present from the beta release.
|
|
||
| Before running {{ model }}, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account). | ||
|
|
||
| ### MOSRS Account |
There was a problem hiding this comment.
Should we say something that this step is also a licence requirement to use the UM model @heidinett ?
That's a comment that's for more than AM3 and for all the ACCESS models (except OM) I guess.
| Join the following projects by requesting membership on their respective NCI project pages: | ||
|
|
||
| - [access](https://my.nci.org.au/mancini/project/access/join) | ||
| - [hh5](https://my.nci.org.au/mancini/project/hh5/join) |
There was a problem hiding this comment.
We don't want to require this. Need to check the config.
| - [hr22](https://my.nci.org.au/mancini/project/hr22/join) | ||
| - [ki32](https://my.nci.org.au/mancini/project/ki32/join) | ||
| - [ki32_mosrs](https://my.nci.org.au/mancini/project/ki32_mosrs/join) | ||
| - [rp23](https://my.nci.org.au/mancini/project/rp23/join) |
There was a problem hiding this comment.
We don't want to require this. Need to check if we can change the suite to use the default user's project instead of rp23.
| - [hh5](https://my.nci.org.au/mancini/project/hh5/join) | ||
| - [hr22](https://my.nci.org.au/mancini/project/hr22/join) | ||
| - [ki32](https://my.nci.org.au/mancini/project/ki32/join) | ||
| - [ki32_mosrs](https://my.nci.org.au/mancini/project/ki32_mosrs/join) |
There was a problem hiding this comment.
Is this changing with the new licence agreement @heidinett @aidanheerdegen ? Sorry, I forgot.
If yes, when does it change?
|
|
||
| ### Connection to an ARE VDI Desktop (optional) | ||
|
|
||
| This documentation has been written from the perspective of running the model over an SSH connection run from a local terminal, however, the commands are transferable to a terminal session within an ARE session. |
There was a problem hiding this comment.
I don't find this very clear whether someone should use ARE or not. Is it because it does not matter as long as they have access to a terminal?
| ssh -Y [email protected] | ||
| ``` | ||
|
|
||
| ### Set up a Persistent Session |
There was a problem hiding this comment.
Need to review this section. It's not for beginners. Need to separate: start a new persistent session and using existing session and cleaning stale sessions.
There was a problem hiding this comment.
CM2 documentation for persistent sessions is structured differently.
What is the criteria to know what should be in the How to Run and what should be in a separate page on ACCESS-Hive?
|
|
||
| For further instructions on getting the _Rose/Cylc_ setup, refer to the [Detailed guide](#rosecylcmosrs-setup). | ||
|
|
||
| ### MOSRS authentication |
There was a problem hiding this comment.
How often do people need to do that? Recommended to do every time? There is a tip for ACCESS-CM2 documentation that isn't reproduced here.
|
|
||
| ### Running the suite | ||
|
|
||
| To run the suite in it's default configuration, run the following commands: |
There was a problem hiding this comment.
| To run the suite in it's default configuration, run the following commands: | |
| To run the suite in its default configuration, run the following commands: |
| !!! tip | ||
| {{ model }} will automatically select the appropriate persistent session. |
There was a problem hiding this comment.
This is different from CM or rAM3 instructions. I'm wondering if we are missing the section to register the persistent session as a target for cylc
| !!! warning | ||
| This will overwrite all existing model output and logs for the same suite. | ||
|
|
||
| ### Reload the suite |
There was a problem hiding this comment.
I wouldn't use this title since "Reload" is explained later. Why not: "Soft restart with changes" ?
There was a problem hiding this comment.
And I would place it before just after the soft restart option.
Currently uses one of the other model logos as a placeholder on the top level navigation page
3 participants
Initial docs for running AM3.
Fixes #993
Type of change
Checklist: