Skip to content
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.

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

683 update access esm how to run #726

Merged
merged 17 commits into from
Aug 26, 2024

Conversation

blimlim
Copy link
Contributor

@blimlim blimlim commented Aug 14, 2024

Description

This pull request updates the run access esm tutorial to match the structure of the OM2 tutorial, and to include changes related to the latest payu updates and the (to be) released configurations.

The new ESM how to run page was set up by copying the OM2 page, and modifying the information to be correct for ESM1.5.

This is not currently ready to merge, as some changes cannot be made until the final release, specifically:

  • The link to the release notes will have to wait until there is a release notes post on the forum.
  • The required payu version might need to wait until the final updates to payu are released.
  • Links to the released configurations on github will have to wait until the release- branches are ready.
  • The postscript example will have to wait for the NetCDF conversion to be finalised.

In the mean time though, it would be great to get feedback and suggestions on the other changes!

Fixes #683

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
  • I have chosen the correct tag for the level of support provided

@blimlim blimlim linked an issue Aug 14, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Aug 14, 2024

PR preview
🛬 Preview link removed because the pull request was closed.

Merge remote-tracking branch 'origin/683-update-access-esm-how-to-run' into 683-update-access-esm-how-to-run
@blimlim
Copy link
Contributor Author

blimlim commented Aug 22, 2024

Hi everyone, I've finally finished adding in some of the more ESM1.5 specific information now that the changes to the configurations and payu are (mostly) finalised and I think it's ready for a review.

The following two points are still waiting on further information/links, but everything else should be ready for a review:

  • The required payu version might need to wait until the final updates to payu are released.
  • Links to the released configurations on github will have to wait until the release- branches are ready.

Sorry about the delay on this!

@blimlim blimlim requested a review from KAUR1984 August 22, 2024 00:19
@KAUR1984
Copy link
Contributor

Thanks for that @blimlim! Looks great to me!

I would perhaps suggest to merge this PR into the development branch for now. For the rest of the changes, happy to create a new PR and once we have all the changes, we can deploy it on the main branch. :)

@blimlim
Copy link
Contributor Author

blimlim commented Aug 22, 2024

Thanks @KAUR1984! I just realised there were a couple of spelling errors which I've just fixed up, and then will merge into development

@aidanheerdegen
Copy link
Member

I'm part way through reviewing. Should I just close off that review and allow you to make the suggested changes?

@blimlim
Copy link
Contributor Author

blimlim commented Aug 22, 2024

That sounds good! I'll wait until I've added any suggested changes before merging.

Copy link
Member

@aidanheerdegen aidanheerdegen left a comment

Choose a reason for hiding this comment

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

Thanks @blimlim! Awesome work.

I have made a number of suggestions, not all are necessarily required, happy to leave it to you to decide what to keep and what to not, or further modify.

I have some thoughts about the post-processing, but that may require changes to the script invocation, which will then have to be changed here to be consistent.

docs/models/configurations/access-esm.md Outdated Show resolved Hide resolved
docs/models/configurations/access-esm.md Outdated Show resolved Hide resolved
docs/models/configurations/access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
blimlim and others added 2 commits August 22, 2024 13:29
@blimlim
Copy link
Contributor Author

blimlim commented Aug 22, 2024

Thanks for spotting those things – I think they're all good suggestions and I've added them in.

I have some thoughts about the post-processing, but that may require changes to the script invocation, which will then have to be changed here to be consistent.

Sounds good, lets see if we can simplify how the script is called.

@blimlim
Copy link
Contributor Author

blimlim commented Aug 23, 2024

I've just updated the docs with the change to the NetCDF conversion behaviour and added in the correct payu version. After looking over everything, I think the information is now correct.

Copy link
Member

@aidanheerdegen aidanheerdegen left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for all the hard work.

docs/models/run-a-model/run-access-esm.md Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
Copy link
Member

@aidanheerdegen aidanheerdegen left a comment

Choose a reason for hiding this comment

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

Just one small change, otherwise looks good and thanks for the changes.

docs/models/run-a-model/run-access-esm.md Outdated Show resolved Hide resolved
Copy link
Member

@aidanheerdegen aidanheerdegen left a comment

Choose a reason for hiding this comment

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

Looks great. Thanks!

@aidanheerdegen aidanheerdegen merged commit 8f8f8ae into development Aug 26, 2024
6 of 7 checks passed
@atteggiani atteggiani deleted the 683-update-access-esm-how-to-run branch August 26, 2024 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update ACCESS-ESM Run Model docs
4 participants