Skip to content

Add restart description and instructions for changing date#302

Merged
blimlim merged 10 commits intomainfrom
296-restart-date-documentation
Jan 26, 2026
Merged

Add restart description and instructions for changing date#302
blimlim merged 10 commits intomainfrom
296-restart-date-documentation

Conversation

@blimlim
Copy link
Copy Markdown
Collaborator

@blimlim blimlim commented Dec 2, 2025

1. Summary:

What has changed?
This PR adds a description of the ESM1.6 restart files and instructions for changing their date to the documentation.

Why was this done?
Changing the restart date is common process when setting up custom experiments, and hence it would be useful to have in the config docs. I thought that it would be worth including an explanation of what the different restart files are.

2. Issues Addressed:

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)?
N/A

5. CI Testing

  • !test repro has been run

N/A

6. Reproducibility
N/A

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

@blimlim blimlim force-pushed the 296-restart-date-documentation branch 6 times, most recently from 39a82e3 to 7efec5c Compare December 3, 2025 01:06
@blimlim blimlim force-pushed the 296-restart-date-documentation branch from 7efec5c to 50a8e58 Compare December 3, 2025 01:13
@blimlim blimlim marked this pull request as ready for review December 3, 2025 01:23
Copy link
Copy Markdown
Member

@ccarouge ccarouge left a comment

Choose a reason for hiding this comment

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

Small suggestions

Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Copy link
Copy Markdown
Collaborator

@anton-seaice anton-seaice left a comment

Choose a reason for hiding this comment

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

Thanks Spencer - looks good

Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
Comment thread documentation/docs/pages/inputs/restarts.md
This was referenced Dec 4, 2025
blimlim and others added 2 commits December 4, 2025 16:19
Co-authored-by: Claire Carouge <ccarouge@users.noreply.github.com>
Co-authored-by: Anton Steketee <79179784+anton-seaice@users.noreply.github.com>
@blimlim
Copy link
Copy Markdown
Collaborator Author

blimlim commented Dec 5, 2025

@ccarouge @anton-seaice, do you think placing the restarts.md page under inputs makes sense? I wasn't too sure but it seemed like the most appropriate place

@ccarouge
Copy link
Copy Markdown
Member

ccarouge commented Dec 8, 2025

do you think placing the restarts.md page under inputs makes sense? I wasn't too sure but it seemed like the most appropriate place

@blimlim , it makes perfect sense for me. It's an input the model needs to define its initial state.

@blimlim
Copy link
Copy Markdown
Collaborator Author

blimlim commented Jan 12, 2026

@anton-seaice @ccarouge, just remembered this one! Did you have any other suggestions?

@anton-seaice
Copy link
Copy Markdown
Collaborator

Happy to approve - payu 1.2.1 is imminent if we want to wait ?

ccarouge
ccarouge previously approved these changes Jan 13, 2026
Copy link
Copy Markdown
Member

@ccarouge ccarouge left a comment

Choose a reason for hiding this comment

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

It looks good. I have two small comments for you or Anton about the sea-ice restart but nothing that needs a re-review from me.

Comment thread documentation/docs/pages/inputs/restarts.md
Comment thread documentation/docs/pages/inputs/restarts.md Outdated
@ccarouge
Copy link
Copy Markdown
Member

and I forgot to say, I've committed a change to mkdocs.yaml to bring in proper icons for the admonition boxes.

@blimlim
Copy link
Copy Markdown
Collaborator Author

blimlim commented Jan 23, 2026

Happy to approve - payu 1.2.1 is imminent if we want to wait ?

Payu 1.2.1 is out and so I've removed the text about the cice_in.nml file

@blimlim blimlim requested a review from anton-seaice January 23, 2026 05:26
Copy link
Copy Markdown
Collaborator

@anton-seaice anton-seaice 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

@blimlim blimlim merged commit 33398ab into main Jan 26, 2026
26 checks passed
@blimlim blimlim deleted the 296-restart-date-documentation branch January 29, 2026 22:27
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.

3 participants