Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
f542616
Start general payu docs
ccarouge Jul 3, 2026
c8b62fd
Changes from reading the rendered version
ccarouge Jul 3, 2026
af76daa
Changes following comments by @anton-seaice
ccarouge Jul 3, 2026
4894017
(#978) - Minor clarifications
ccarouge Jul 3, 2026
651f521
(#978) - Incorporate Jo's feedback
ccarouge Jul 3, 2026
e1036c1
(#978) - Formatting.
ccarouge Jul 3, 2026
8e9aab2
(#978) - Additions from the run ESM1.5 page.
ccarouge Jul 3, 2026
9d7545a
(#978) - try and improve layout on run a model index page.
ccarouge Jul 3, 2026
4cdc925
(#560) - Redesign after review.
ccarouge Jul 3, 2026
2db86b2
(#978) - Additional changes
ccarouge Jul 3, 2026
f1e317e
(#978) - A few more edits
ccarouge Jul 3, 2026
dccd5e8
Update diagram for payu directory structure
ccarouge Jul 3, 2026
584bd32
Fixing image link
ccarouge Jul 3, 2026
1dc930b
(#978) - edits for review comments
ccarouge Jul 3, 2026
c219a6d
(#978) - start of edits from review
ccarouge Jul 3, 2026
db3e21c
(#978) - More changes from review
ccarouge Jul 3, 2026
a327470
(#978) - Addressed bigger review comments.
ccarouge Jul 3, 2026
424948f
(#978) - Add colours to `payu clone` output for readability
ccarouge Jul 3, 2026
8e65357
Use `base_path` instead of `path` for sync option
ccarouge Jul 3, 2026
822070d
Update instructions for custom restart path in payu.md
ccarouge Jul 3, 2026
9640d0e
(#978) - responses to reviews
ccarouge Jul 3, 2026
1e5507f
Replace diagram PNG with SVG
ccarouge Jul 3, 2026
5169eff
Test snippets in ACCESS-ESM1.5 case
ccarouge Jul 3, 2026
0ef2adb
Test line continuation
ccarouge Jul 3, 2026
48722fb
Try with include-markdown extension
ccarouge Jul 3, 2026
34da000
Fix include-markdown inclusion
ccarouge Jul 3, 2026
8393876
Add more sections
ccarouge Jul 3, 2026
ae26e14
Include files for "get the configuration" section
ccarouge Jul 3, 2026
449658f
Try macros in terminal
ccarouge Jul 3, 2026
5e109f3
Work on get a model configuration
ccarouge Jul 3, 2026
255d3ca
Add testing the configuration
ccarouge Jul 3, 2026
6a28bca
Give the URL to the config repo
ccarouge Jul 3, 2026
e1520d4
Add run experiment
ccarouge Jul 3, 2026
70e9e03
Add run_length info.
ccarouge Jul 3, 2026
25030ba
Change admonition type
ccarouge Jul 3, 2026
758ea47
Add include for monitoring
ccarouge Jul 3, 2026
bacd158
Move log file description with the file organisation for payu
ccarouge Jul 3, 2026
e0886ba
Remove redundant text
ccarouge Jul 3, 2026
6890412
Add includes to Configuration modifications
ccarouge Jul 3, 2026
438ca83
To the end of the file
ccarouge Jul 3, 2026
3aaa478
Test configs_docs link
ccarouge Jul 3, 2026
c87e457
Final options in collapsible sections.
ccarouge Jul 3, 2026
430124d
More fix
ccarouge Jul 3, 2026
b8abac2
Corrections from read through
ccarouge Jul 3, 2026
299e6bd
Responses to reviews
ccarouge Jul 3, 2026
717db31
Fix offsets in payu-about section
ccarouge Jul 3, 2026
281a645
Move config vs exp to different include file.
ccarouge Jul 3, 2026
26dbcf9
Various formatting and other changes
ccarouge Jul 3, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/assets/payu_directory_structure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/css/access-nri.css
Original file line number Diff line number Diff line change
Expand Up @@ -1234,6 +1234,17 @@ img.terminal-switch:hover ~ .terminal-switch-tooltip {
.git-cyan {
color: #00C6C7;
}
.payu-yellow {
color:#ecff1e;
}
.payu-red {
color: #b78683;
}
.payu-dark-yellow {
color: #f9bd26;
}



/* ===============================================================
General styling for html tabs
Expand Down
573 changes: 573 additions & 0 deletions docs/includes/payu.md

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions docs/includes/terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--start:terminology-conf-vs-exp-->
### _Configuration_ and _experiment_ definitions

The terms _configuration_ and _experiment_ are not interchangeable although they are closely related.

- A _configuration_ defines a specific way to run the model it relates to.<br>
A configuration is defined by:

- model version and build (model executable(s))
- set of input files (ancillaries, forcings, restarts)
- set of physical and modelling options for each model component, such as namelists, configuration files and MPI layout

Changing any one of these elements creates a new configuration

- An _experiment_ is a realisation of a configuration: a series of sequential runs that generate model data over a span of model time.
<!--start:terminology-conf-vs-exp-->

30 changes: 21 additions & 9 deletions docs/models/run_a_model/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,27 @@ If you are unsure which ACCESS model is the best fit for your application, you c
Run ACCESS-CM2
</div>
</a>
<!-- Run ACCESS-rAM -->
<a href="run_access-ram3" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/model_visualisation/access_ram_model_visualisation.png" alt="ACCESS-rAM">
</div>
<div class="card-text-container bold">
Run ACCESS-rAM3
</div>
</a>
</div>

<div class="card-container">
<!-- Payu -->
<a href="/models/run_a_model/payu" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img class="img-contain with-padding white-background" src="/assets/rose_cylc_logo.png" alt="Run models using Payu">
</div>
<div class="card-text-container bold">
Run models using Payu
</div>
</a>
<!-- Run ACCESS-ESM -->
<a href="run_access-esm" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
Expand Down Expand Up @@ -49,13 +70,4 @@ If you are unsure which ACCESS model is the best fit for your application, you c
Run ACCESS-OM3
</div>
</a>
<!-- Run ACCESS-rAM -->
<a href="run_access-ram3" class="vertical-card aspect-ratio1to1">
<div class="card-image-container">
<img class="img-contain with-padding white-background" src="/assets/model-config-logos/model_visualisation/access_ram_model_visualisation.png" alt="ACCESS-rAM">
</div>
<div class="card-text-container bold">
Run ACCESS-rAM3
</div>
</a>
</div>
789 changes: 196 additions & 593 deletions docs/models/run_a_model/run_access-esm.md

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,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:
Expand Down Expand Up @@ -137,10 +138,11 @@ nav:
- models/run_a_model/index.md
- Run models using Rose/Cylc: models/run_a_model/rose_cylc.md
- Run ACCESS-CM2: models/run_a_model/run_access-cm2.md
- Run ACCESS-rAM3: models/run_a_model/run_access-ram3.md
- Run models using Payu: models/run_a_model/payu.md
- Run ACCESS-ESM1.5: models/run_a_model/run_access-esm.md
- Run ACCESS-OM2: models/run_a_model/run_access-om2.md
- Run ACCESS-OM3: models/run_a_model/run_access-om3.md
- Run ACCESS-rAM3: models/run_a_model/run_access-ram3.md
- Build a Model:
- models/build_a_model/index.md
- Modify and build an ACCESS model's source code: models/build_a_model/build_source_code.md
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading