Add AM3 specific run docs by Whyborn · Pull Request #1058 · ACCESS-NRI/ACCESS-Hive-Docs

Whyborn · 2025-11-04T03:48:52Z

ACCESS-Hive Docs

Description

Adds a bare-minimum page that, in combination with the in-progress Rose/Cylc docs, describes briefly how to run AM3.

Type of change

New link / content

Checklist:

The new content is accessible and located in the appropriate section
My changes do not break navigation and do not generate new warnings
I have checked that the links are valid and point to the intended content
I have checked my code/text and corrected any misspellings

atteggiani · 2025-11-04T03:56:35Z

Hi @Whyborn,

I see this PR relates to #1056.
Do you think it would be a good idea to have both "Run a model" and "model overview" pages for AM3 in one single PR?

Whyborn · 2025-11-04T04:16:29Z

I did think about whether they should be separate or a single PR. I came to the conclusion that they should be separate because the model page in #1056 can be merged independently of the Rose/Cylc docs, while this shouldn't be merged before the Rose/Cylc docs are finalised.

atteggiani · 2025-11-04T04:22:27Z

I understand and that's true.
However, both pages relate to AM3 release, and they should be merged at the same time whenever the Beta (or Alpha) release happens.

I think the Rose/Cylc page will be ready before we're ready for AM3 release (i.d., before we're ready to merge these pages), so I would not see that a a problem.

github-actions · 2025-11-04T04:29:10Z

PR Preview
🚀 Preview of PR head commit `e42f5a3` deployed to https://docs.access-hive.org.au/pr-previews/1058
2026-03-20 03:03 AEDT
Preview generated through the Deploy to GitHub Pages workflow run 23304253625.

Whyborn · 2025-11-04T04:35:07Z

Ok, I'll merge this branch with the one from #1056 and close the other PR

ccarouge

A few comments, nothing major.

docs/models/run-a-model/run-access-am.md

docs/models/access-am.md

docs/models/index.md

docs/models/run-a-model/run-access-am.md

docs/models/access-am.md

docs/models/run_a_model/run_access-am3.md

Whyborn · 2025-11-27T00:24:18Z

@atteggiani Just need your review before merging

atteggiani · 2025-11-27T00:52:07Z

Getting on it.

ccarouge · 2025-11-27T02:44:45Z

@Whyborn We don't merge for alpha! We only merge at the beta release!

Whyborn · 2025-11-27T02:49:38Z

@ccarouge Oh we don't? So we just keep any links pointing at the PR preview until beta?

ccarouge · 2025-11-27T03:39:22Z

@Whyborn yes.

atteggiani

Thank you @Whyborn and @ccarouge for working on this.

I think it's overall pretty good!
I added some small fixes and suggestions. Please refer to the specific comments for details.

docs/models/run_a_model/index.md

docs/models/access_models/access-am.md

docs/models/run_a_model/run_access-am3.md

docs/models/access_models/access-am.md

docs/models/run_a_model/run_access-am3.md

Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>

…ESS-Hive-Docs into 1039-AM3-run-a-model-docs

Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>

atteggiani

Thank you @Whyborn for addressing my comments.

The updates look all pretty good!

Note there are still some files that show here when they should not be within the changed filetree. Also the indentation changes in the mkdocs.yml still seems to be there.

Apart from these minor issues, this PR is ready to be merged.

atteggiani · 2025-12-03T03:50:18Z

docs/models/index.md

This is still showing up.

atteggiani · 2025-12-03T03:50:46Z

docs/models/access_models/access-esm.md

This is still showing up.

mkdocs.yml

Whyborn · 2025-12-03T22:41:00Z

@atteggiani I don't see any of the whitespace changes on the Files changed tab?

atteggiani

Everything looks good now.

Thank you @Whyborn

mkdocs.yml

atteggiani · 2025-12-08T23:52:01Z

I will mark this as draft as this is an Alpha Release and this PR should not be merged yet.

Whyborn added 2 commits October 29, 2025 17:07

Create quick start for AM3

b5251dc

Minor change to wording

4a20042

Whyborn requested a review from ccarouge November 4, 2025 03:49

Add changes from add-AM3-model-page branch

302deeb

ccarouge previously approved these changes Nov 7, 2025

View reviewed changes

Add access to list of projects

76b0895

Whyborn dismissed ccarouge’s stale review via 76b0895 November 10, 2025 22:12

ccarouge reviewed Nov 10, 2025

View reviewed changes

docs/models/access-am.md Outdated Show resolved Hide resolved

Whyborn added 4 commits November 11, 2025 12:07

Minor fixes

f2e3091

reverse land_bgc

66bdeac

Fill in missing hyperlinks

549a3a2

Change suite to set

9771637

Whyborn requested review from atteggiani and ccarouge November 11, 2025 22:59

Whyborn added 8 commits November 12, 2025 15:54

Add changes from add-AM3-model-page branch

9e71a44

Add access to list of projects

db89ae1

Minor fixes

a95b40a

reverse land_bgc

dbf46da

Fill in missing hyperlinks

4232edb

Change suite to set

26c743e

Be slightly more verbose in Quick start section

8928881

Merge commit

6af5064

Whyborn mentioned this pull request Nov 13, 2025

Initial documentation package for ACCESS-AM3 #993

Open

ccarouge reviewed Nov 13, 2025

View reviewed changes

docs/models/run_a_model/run_access-am3.md Show resolved Hide resolved

Add message about getting access to repos and link to config docs

24a5051

Whyborn dismissed ccarouge’s stale review via 9e8d910 November 27, 2025 00:17

atteggiani force-pushed the development branch from 254ca6a to 963790e Compare November 27, 2025 06:11

atteggiani requested changes Nov 30, 2025

View reviewed changes

Whyborn and others added 12 commits December 1, 2025 15:09

Apply suggestions from code review

929f8e6

Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>

Revert accidental whitespace changes

e614c03

Merge branch '1039-AM3-run-a-model-docs' of github.com:ACCESS-NRI/ACC…

606c1fe

…ESS-Hive-Docs into 1039-AM3-run-a-model-docs

mkdocs additions without unintential whitespace

acdf958

Add release statement to AM3 pages

40f80bf

Update run_a_model cards with vn number

60f3c30

Apply suggestions from code review

6a158a2

Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>

Add cards to top of page

9b139f2

Change to css and associated removals in page

424ab31

Flesh out release admonition

4a52bde

Update docs/models/run_a_model/run_access-am3.md

213d9c9

Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>

Apply suggestions from code review

3793924

Co-authored-by: Davide Marchegiani <davide.marchegiani@anu.edu.au>

Whyborn requested a review from atteggiani December 2, 2025 21:26

atteggiani requested changes Dec 3, 2025

View reviewed changes

atteggiani previously approved these changes Dec 3, 2025

View reviewed changes

mkdocs.yml Show resolved Hide resolved

atteggiani marked this pull request as draft December 8, 2025 23:52

Reformatted prerequisites

674d368

atteggiani dismissed their stale review via 674d368 December 16, 2025 23:15

atteggiani and others added 2 commits December 17, 2025 11:07

Fixed broken links

f9e0974

Use 'release-n96e' as example branch instead of "main"

e42f5a3

Conversation

Whyborn commented Nov 4, 2025

ACCESS-Hive Docs

Description

Type of change

Checklist:

Uh oh!

atteggiani commented Nov 4, 2025

Uh oh!

Whyborn commented Nov 4, 2025

Uh oh!

atteggiani commented Nov 4, 2025

Uh oh!

github-actions bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Whyborn commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ccarouge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Whyborn commented Nov 27, 2025

Uh oh!

atteggiani commented Nov 27, 2025

Uh oh!

ccarouge commented Nov 27, 2025

Uh oh!

Whyborn commented Nov 27, 2025

Uh oh!

ccarouge commented Nov 27, 2025

Uh oh!

atteggiani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

atteggiani left a comment

Choose a reason for hiding this comment

Uh oh!

atteggiani Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

atteggiani Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Whyborn commented Dec 3, 2025

Uh oh!

atteggiani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

atteggiani commented Dec 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Nov 4, 2025 •

edited

Loading

Whyborn commented Nov 4, 2025 •

edited

Loading