Skip to content

General payu docs for Run a Model section #1107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ccarouge wants to merge 25 commits into
base: development
Choose a base branch
from
Draft

General payu docs for Run a Model section #1107

Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
7811e32
Start general payu docs
ccarouge Dec 12, 2025
479761c
Changes from reading the rendered version
ccarouge Dec 17, 2025
f6dd91e
Changes following comments by @anton-seaice
ccarouge Jan 5, 2026
2575fa0
(#978) - Minor clarifications
ccarouge Jan 19, 2026
7774dfa
(#978) - Incorporate Jo's feedback
ccarouge Jan 19, 2026
b0a93f1
(#978) - Formatting.
ccarouge Jan 19, 2026
68f3b23
(#978) - Additions from the run ESM1.5 page.
ccarouge Jan 20, 2026
70a3daf
(#978) - try and improve layout on run a model index page.
ccarouge Jan 20, 2026
a489e23
Merge remote-tracking branch 'origin/development' into 978-General-ho…
anton-seaice Jan 26, 2026
b1e269d
(#560) - Redesign after review.
ccarouge Feb 17, 2026
d05dfc0
(#978) - Additional changes
ccarouge Feb 18, 2026
dfb6258
(#978) - A few more edits
ccarouge Feb 18, 2026
7106ace
Update diagram for payu directory structure
ccarouge Feb 18, 2026
088f2c8
General how to use Payu Docs
ccarouge Feb 18, 2026
18a6b39
Fixing image link
ccarouge Feb 18, 2026
48a3a94
(#978) - edits for review comments
ccarouge Feb 24, 2026
d8b3a42
Merge branch 'development' into 978-General-how-to-use-Payu-Docs
ccarouge Feb 24, 2026
8b7ced4
(#978) - start of edits from review
ccarouge Mar 2, 2026
6520331
(#978) - More changes from review
ccarouge Apr 22, 2026
cb1d220
(#978) - Addressed bigger review comments.
ccarouge Apr 22, 2026
eed62a8
(#978) - Add colours to `payu clone` output for readability
ccarouge Apr 22, 2026
5c3a458
Use `base_path` instead of `path` for sync option
ccarouge Apr 24, 2026
f249ed5
Update instructions for custom restart path in payu.md
ccarouge Apr 24, 2026
11d4654
(#978) - responses to reviews
ccarouge May 4, 2026
77eb63d
Replace diagram PNG with SVG
ccarouge Jun 2, 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
Binary file added docs/assets/payu_directory_structure.png
View file
Open in desktop
Comment thread
ccarouge marked this conversation as resolved.
Outdated

@aidanheerdegen aidanheerdegen Apr 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a source file that can be included as well so the diagram can be modified/updated as required?

@ccarouge ccarouge Apr 24, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, need a Lucid Chart account to access the source.

@aidanheerdegen aidanheerdegen Apr 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doh. Can you export an SVG that could be edited using something like Inkscape?

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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1214,6 +1214,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
30 changes: 21 additions & 9 deletions docs/models/run_a_model/index.md
View file
Open in desktop
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>
Loading
Loading