Skip to content

Add AM3 specific run docs#1058

Draft
Whyborn wants to merge 79 commits into
developmentfrom
1039-AM3-run-a-model-docs
Draft

Add AM3 specific run docs#1058
Whyborn wants to merge 79 commits into
developmentfrom
1039-AM3-run-a-model-docs

Conversation

@Whyborn

@Whyborn Whyborn commented Nov 4, 2025

Copy link
Copy Markdown
Contributor

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

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

Copy link
Copy Markdown
Contributor

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

Whyborn commented Nov 4, 2025

Copy link
Copy Markdown
Contributor Author

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

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented Nov 4, 2025

Copy link
Copy Markdown
PR Preview
🚀 Preview of PR head commit a537b6d deployed to https://docs.access-hive.org.au/pr-previews/1058
2026-07-03 16:47 AEST
Preview generated through the Deploy to GitHub Pages workflow run 28643610391.

@Whyborn

Whyborn commented Nov 4, 2025

Copy link
Copy Markdown
Contributor Author

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

ccarouge
ccarouge previously approved these changes Nov 7, 2025

@ccarouge ccarouge left a comment

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.

A few comments, nothing major.

Comment thread docs/models/run-a-model/run-access-am.md Outdated
Comment thread docs/models/run-a-model/run-access-am.md Outdated
Comment thread docs/models/access-am.md Outdated
Comment thread docs/models/index.md Outdated
Comment thread docs/models/run-a-model/run-access-am.md Outdated
Comment thread docs/models/access-am.md Outdated
Comment thread docs/models/run_a_model/run_access-am3.md
@ccarouge

Copy link
Copy Markdown
Member

@Whyborn yes.

@atteggiani atteggiani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread docs/models/run_a_model/index.md Outdated
Comment thread docs/models/access_models/access-am.md Outdated
Comment thread docs/models/access_models/access-am.md Outdated
Comment thread docs/models/run_a_model/run_access-am3.md
Comment thread docs/models/access_models/access-am.md Outdated
Comment thread docs/models/run_a_model/run_access-am3.md
Comment thread docs/models/run_a_model/run_access-am3.md Outdated
Comment thread docs/models/run_a_model/run_access-am3.md Outdated
Comment thread docs/models/run_a_model/run_access-am3.md Outdated
Comment thread docs/models/run_a_model/run_access-am3.md Outdated
@Whyborn Whyborn requested a review from atteggiani December 2, 2025 21:26

@atteggiani atteggiani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread docs/models/index.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is still showing up.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is still showing up.

Comment thread mkdocs.yml
@Whyborn

Whyborn commented Dec 3, 2025

Copy link
Copy Markdown
Contributor Author

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

atteggiani
atteggiani previously approved these changes Dec 3, 2025

@atteggiani atteggiani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Everything looks good now.

Thank you @Whyborn

Comment thread mkdocs.yml
@atteggiani

Copy link
Copy Markdown
Contributor

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

@atteggiani atteggiani marked this pull request as draft December 8, 2025 23:52
ccarouge added 2 commits July 1, 2026 10:36
These are not needed anymore now that the SOCRATES files are located under vk83
Removed tip for ki32 membership since that project isn't required anymore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Add AM3 Run-a-model Docs Initial documentation package for ACCESS-AM3

4 participants