Skip to content

Update checkpointing docs to include new functionality#227

Open
andrewcoughtrie wants to merge 1 commit intoMetOffice:mainfrom
andrewcoughtrie:checkpoint_docs
Open

Update checkpointing docs to include new functionality#227
andrewcoughtrie wants to merge 1 commit intoMetOffice:mainfrom
andrewcoughtrie:checkpoint_docs

Conversation

@andrewcoughtrie
Copy link
Collaborator

@andrewcoughtrie andrewcoughtrie commented Feb 5, 2026

PR Summary

Sci/Tech Reviewer: @stevemullerworth
Code Reviewer:

Updated the checkpointing documentation to include the new functionality around flexible checkpointing.

closes #23

Code Quality Checklist

  • I have performed a self-review of my own code
  • My code follows the project's style guidelines
  • Comments have been included that aid understanding and enhance the readability of the code
  • My changes generate no new warnings
  • All automated checks in the CI pipeline have completed successfully

Testing

  • I have tested this change locally, using the LFRic Apps rose-stem suite
  • If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g. kgo changes)
  • I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.)
  • Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e. the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes)

trac.log

Security Considerations

  • I have reviewed my changes for potential security issues
  • Sensitive data is properly handled (if applicable)
  • Authentication and authorisation are properly implemented (if applicable)

Performance Impact

  • Performance of the code has been considered and, if applicable, suitable performance measurements have been conducted

AI Assistance and Attribution

  • Some of the content of this change has been produced with the assistance of Generative AI tool name (e.g., Met Office Github Copilot Enterprise, Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the Simulation Systems AI policy (including attribution labels)

Documentation

  • Where appropriate I have updated documentation related to this change and confirmed that it builds correctly

PSyclone Approval

  • If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the TCD Team

Sci/Tech Review

  • I understand this area of code and the changes being added
  • The proposed changes correspond to the pull request description
  • Documentation is sufficient (do documentation papers need updating)
  • Sufficient testing has been completed

(Please alert the code reviewer via a tag when you have approved the SR)

Code Review

  • All dependencies have been resolved
  • Related Issues have been properly linked and addressed
  • CLA compliance has been confirmed
  • Code quality standards have been met
  • Tests are adequate and have passed
  • Documentation is complete and accurate
  • Security considerations have been addressed
  • Performance impact is acceptable

@andrewcoughtrie andrewcoughtrie changed the title Update checkpointing to include new functionality Update checkpointing docs to include new functionality Feb 5, 2026
@andrewcoughtrie andrewcoughtrie marked this pull request as ready for review February 5, 2026 11:55
@andrewcoughtrie andrewcoughtrie added this to the Summer 2026 milestone Feb 5, 2026
Copy link
Collaborator

@stevemullerworth stevemullerworth left a comment

Choose a reason for hiding this comment

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

Couple of minor tweaks to reflect that there may be more than one dump.

The LFRic atmosphere ``lfric_atm`` application can be configured to generate a
checkpoint dump at the end of each model run. The checkpoint dump can be read in
The LFRic atmosphere ``lfric_atm`` application can be configured to generate
checkpoint dumps at multiple points within a model run. The checkpoint dump can be read in
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
checkpoint dumps at multiple points within a model run. The checkpoint dump can be read in
checkpoint dumps at multiple points within a model run. A checkpoint dump can be read in

checkpoint dump at the end of each model run. The checkpoint dump can be read in
The LFRic atmosphere ``lfric_atm`` application can be configured to generate
checkpoint dumps at multiple points within a model run. The checkpoint dump can be read in
by a new integration of the model allowing further timesteps to be run. The dump
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
by a new integration of the model allowing further timesteps to be run. The dump
by a new integration of the model allowing further timesteps to be run. Each dump

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 documentation to include flexible checkpointing

2 participants