Build and deployment documentation

[ccarouge]

1. Summary:

Added documentation about the building and deployment process for ACCESS-ESM1.6

2. Issues Addressed:

• Fixes Build and deployment documentation #279

3. Dependencies (e.g. on payu, or model)

This change requires changes to (note pull request(s) where relevant):

• workflow manager (payu):
• model deployment (ACCESS-ESM1.6):
• model component or library dependency:
• input workflow:

4. Ad-hoc Testing

What ad-hoc testing was done? How are you convinced this change is correct (plots are good)?

Documentation only. No testing done. Relying on build preview in PR to correct formatting.

5. CI Testing

• !test repro has been run
• N/A: documentation only

6. Reproducibility

Is this reproducible with the previous commit? (If not, why not?)

• Yes
• No - !test repro commit has been run.

8. Manifests

Have you changed the executable, the input files and/or the restart files?

• Yes
• No

If yes, have you updated the manifests?

• Yes
• No

To update the manifests, run payu setup (in a cloned copy of your feature branch) with reproducibility tests turned off:

manifest:
  reproduce:
    exe: false
    input: false
    restart: false
runlog:
  enable: false

Then commit the newly created manifest files (under manifests/) only to the branch for this PR.

7. Documentation

Is the documentation updated?

• Yes
• N/A

9. Merge Strategy

• Merge commit
• Rebase and merge
• Squash

[ccarouge]

@atteggiani The config docs for ESM1.6 fail to deploy with the preview. Does it need all the PR previews to work in order to deploy? I'm happy to go and fix PR 252, just making sure that should solve the problem before investing time.

[atteggiani]

@atteggiani The config docs for ESM1.6 fail to deploy with the preview. Does it need all the PR previews to work in order to deploy? I'm happy to go and fix PR 252, just making sure that should solve the problem before investing time.

Yes it needs all PR previews to work, unfortunately.
If the fix takes time, you might try writing a line with !no-pr-preview in the body of the PR (PR #252 in this case). It should not trigger that PR preview. I haven't tested this properly due to RTD changes so it might not work, but it's worth a try.
It needs to be the first line of the PR body.

Then you would need to re-trigger this PR. You cannot simply retrigger the build manually, so you'll have to add a new commit or amend (no edits) and force push the latest one.

[chrisb13]

Thanks @ccarouge, fwiw, you might find some of this material helpful:

• https://access-om3-configs.access-hive.org.au/infrastructure/Building/
• https://access-community-hub.github.io/access-iom3-configs/infrastructure/Building/

[ccarouge]

PR #252 was fixed and the preview workflow ran from #252 has now created a preview (dismiss the failed build in this PR).

@chrisb13 I'll have a look at the links you shared.

[chrisb13]

@chrisb13 I'll have a look at the links you shared.

Sure thing, @anton-seaice might be a helpful person to canvas too.

[aidanheerdegen]

A couple of comments, but otherwise seems good, thanks.

[ccarouge]

@anton-seaice Could you review this, please? I will be away so if you can review for 2nd Feb that would be great.

[anton-seaice]

Sorry a bit of a chaotic review, I can have another look as needed

[ccarouge]

Thanks for the review @anton-seaice . I've replied to a few comments and I have a modified version of the text for review.

[anton-seaice]

Looks - good . Some minor refinements from me

[ccarouge]

@anton-seaice I've updated these build instructions for ESM1.6. Do you mind if I rebase so I can sign commits that aren't signed? It will break the review stuff so I prefer to ask before going ahead.

Another question: do we want to wait for the release of ESM1.6 to push this live or does it not matter? A few things here will only be accessible or possible for users after a release.

[anton-seaice]

No concerns about either.

I think we wont advertise the docs until we advertise the release, so its fine to update the docs

[ccarouge]

@anton-seaice One last one! I've rebased the changes to sign off everything, I've checked all the links and re-read the pages after the rebase to check the text looked correct.

[anton-seaice]

Thanks Claire !