Skip to content

Commit 7f52ac0

Browse files
committed
Include files for "get the configuration" section
1 parent 21c4866 commit 7f52ac0

2 files changed

Lines changed: 11 additions & 21 deletions

File tree

docs/includes/payu.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,15 @@ After joining the _vk83_ project, load the _payu_ module:
9393
module load payu
9494

9595
To check that _payu_ is available, run:
96-
96+
ø
9797
payu --version
9898
<!--end:access-payu-->
9999

100100
## Run an experiment
101101

102102
### Get the model configuration
103103

104+
<!--start:get-config-payu-->
104105
All model configurations are hosted in a GitHub repository where each configuration is maintained in its own branch.<br>
105106

106107
To get a local copy of a configuration, you need to:
@@ -111,7 +112,9 @@ To get a local copy of a configuration, you need to:
111112
- Choose a name for your experiment, `<local-branch>`. It is recommended to choose a descriptive name, specific to your experiment. Note that the experiment name will be formed using the _control_ directory's name and this `<local-branch>` name.
112113

113114
Then, you can get the chosen configuration using `payu clone`.
115+
<!--end:get-config-payu-->
114116

117+
<!--start:payu-clone-example-->
115118
For example, if you want to do a sensitivity experiment about diffusivity in ACCESS-OM2 using the configuration `release-1deg_jra55_ryf`. You decide the following:
116119

117120
- `<repository>` and `<branch>`: base your experiment off the branch, `release-1deg_jra55_ryf`, from the repository, `https://github.com/ACCESS-NRI/access-om2-configs`

docs/models/run_a_model/run_access-esm.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ All {{model}} configurations are open source, licensed under [CC BY 4.0](https:/
6060

6161
## Workflow manager, _payu_
6262

63-
??? abstract What is _payu_ and how are the simulation files organised by _payu_
63+
??? abstract "What is _payu_ and how are the simulation files organised by _payu_"
6464
{%
6565
include-markdown "includes/payu.md"
6666
start="<!--start:about-->"
6767
end="<!--end:about-->"
6868
%}
6969

70-
??? abstract Accessing _payu_
70+
??? abstract "Accessing _payu_"
7171

7272
{%
7373
include-markdown "includes/payu.md"
@@ -82,28 +82,15 @@ All {{model}} configurations are open source, licensed under [CC BY 4.0](https:/
8282
All released {{ model }} configurations are available from the [{{ model }} configs]({{github_configs}}) GitHub repository.<br>
8383
Released configurations are tested and supported by ACCESS-NRI, as an adaptation of those originally developed by [CSIRO](https://www.csiro.au/en/research/environmental-impacts/climate-change/climate-science-centre) and [CLEX CMS](https://github.com/coecms/access-esm).
8484

85-
For more information on {{ model }} configurations, check [{{model}}][model configurations] page.
86-
87-
More information about the available experiments and the naming scheme of the branches can also be found in the [{{ model }} configs]({{github_configs}}) GitHub repository.
88-
89-
The first step is to choose a configuration from those available.<br>
90-
91-
For example, if the required configuration is the co2 concentration driven pre-industrial configuration, then the branch to select is [`release-preindustrial+concentrations`](https://forum.access-hive.org.au/t/access-esm1-5-release-information/2352).
92-
93-
To clone this branch to a location on _Gadi_, run:
94-
95-
mkdir -p ~/access-esm1.5
96-
cd ~/access-esm1.5
97-
payu clone -b expt -B release-preindustrial+concentrations {{ github_configs }} preindustrial+concentrations
85+
{%
86+
include-markdown "includes/payu.md"
87+
start="<!--start:get-config-payu-->"
88+
end="<!--end:get-config-payu-->"
89+
%}
9890

9991
!!! tip
10092
If you want to restart your experiment from a specific restart point, please refer to [Start the run from a specific restart file](#specific-restart).
10193

102-
In the example above the `payu clone` command clones the concentration driven pre-industrial configuration (`-B release-preindustrial+concentrations`)
103-
to a new experiment branch (`-b expt`) to a directory named `preindustrial+concentrations`.
104-
105-
!!! admonition tip
106-
Anyone using a configuration is advised to clone only a single branch (as shown in the example above) and not the entire repository.
10794

10895
<terminal-window>
10996
<terminal-line data="input">mkdir -p ~/access-esm1.5</terminal-line>

0 commit comments

Comments
 (0)