Skip to content

Conversation

@joewallwork
Copy link
Contributor

@joewallwork joewallwork commented Jan 8, 2026

XIOS: properly handle filename patterns

Fixes #935
Fixes #997
Fixes #898
Fixes #933
Makes #967 redundant
Refinement of #1002
Merges into #1010
Merges into #1015

Task List

  • Defined the tests that specify a complete and functioning change (It may help to create a design specification & test specification)
  • Implemented the source code change that satisfies the tests
  • Documented the feature by providing worked example
  • Completed the pre-Request checklist below

Change Description

This PR fixes several things related to how restarts and diagnostics are configured with XIOS:

  1. Properly handle file patterns in filenames.
  2. Restart file output frequency and split frequency are aligned so that each output file dump only includes a single timestep's worth of data.
  3. Restart files are only read once.
  4. Ensure XIOS writes the first timestep.

Whilst file patterns are made consistent with what's used elsewhere in nextSIM-DG, the output filenames show the range of datetimes separated by a hyphen.


Test Description

Tests are updated to account for the new behaviour.

I decided to drop XiosFile_test because it is no longer needed. This meant that we could drop the annoying unittest special case. This is what gives the large number of lines removed.


Documentation Impact

The XIOS documentation page has been updated accordingly.


Pre-Request Checklist

  • The requirements of this pull request are fully captured in an issue or design specification and are linked and summarised in the description of this PR
  • No new warnings are generated
  • The documentation has been updated (or an issue has been created to track the corresponding change)
  • Methods and Tests are commented such that they can be understood without having to obtain additional context
  • This PR/Issue is labelled as a bug/feature/enhancement/breaking change
  • This change conforms to the conventions described in the README

@joewallwork joewallwork self-assigned this Jan 8, 2026
@joewallwork joewallwork added enhancement New feature or request ICCS Tasks or reviews for the ICCS team labels Jan 8, 2026
@joewallwork joewallwork marked this pull request as ready for review January 9, 2026 09:32
@joewallwork joewallwork changed the base branch from issue977_xios-diagnostic-averaging to xios-postprocess-dims January 13, 2026 16:15
@joewallwork joewallwork force-pushed the issue898_xios-filename-patterns branch from 9207a40 to 37aff6d Compare January 13, 2026 16:15
@joewallwork
Copy link
Contributor Author

Changed the base of this PR so that it targets #1015 rather than #1010.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request ICCS Tasks or reviews for the ICCS team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants