Skip to content

Conversation

@EdHone
Copy link
Contributor

@EdHone EdHone commented Jan 20, 2026

PR Summary

Sci/Tech Reviewer: @harry-shepherd
Code Reviewer: @mo-lucy-gordon

This PR enables the handling of cyclic data files(files which we start reading again from the beginning once we reach the end) by the new lfric-xios temporal controller. The contents of this PR are:

  • a simple switch within the source code to enable reading cyclic data
  • new functionality to perform an additional "initial" read of data where necessary (when our first model step is not perfectly aligned with a file datapoint)
    • two new integration tests (NonSync) which exercise this functionality
  • several integrations tests which exercise the reading of cyclic data
  • new test capability to generate plots to check the validity of the tests

Code Quality Checklist

(Some checks are automatically carried out via the CI pipeline)

  • 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

Testing

  • I have tested this change locally, using the LFRic Core rose-stem suite
  • If required (e.g. API changes) I have also run the LFRic Apps test suite
    using this branch
  • 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)

Some plots from the LFRic-XIOS integration tests which show that the data is being correctly digested
LfricXiosFullCyclicTest
LfricXiosNonCyclicNonSyncTest

trac.log

Test Suite Results - lfric_core - lfric_core-230-cyclic-read/run4

Suite Information

Item Value
Suite Name lfric_core-230-cyclic-read/run4
Suite User edward.hone
Workflow Start 2026-01-26T13:26:17
Groups Run developer
Dependency Reference Main Like
lfric_core EdHone/lfric_core@230-cyclic-read False
SimSys_Scripts MetOffice/SimSys_Scripts@2025.12.1 True

Task Information

✅ succeeded tasks - 372

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
    tooscollabdevteam@metoffice.gov.uk

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

@EdHone EdHone marked this pull request as draft January 20, 2026 20:54
@EdHone EdHone marked this pull request as ready for review January 21, 2026 21:33
Copy link
Contributor

@harry-shepherd harry-shepherd left a comment

Choose a reason for hiding this comment

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

Just a couple of trivial changes

@EdHone
Copy link
Contributor Author

EdHone commented Jan 28, 2026

Thanks @harry-shepherd - all comments addressed in the latest commit

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.

Cyclic file reading with lfric_xios temporal controller

2 participants