File behaviour for restarts and diagnostics (take 2) #1002
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joewallwork
added
bug
10 tasks
joewallwork
force-pushed
the
issue935_xios-landmask-take2
branch
from
de49974 to
83d6c40
Compare
joewallwork
force-pushed
the
issue935_xios-landmask-take2
branch
from
83d6c40 to
7888b37
Compare
10 tasks
Contributor
Author
10 tasks
joewallwork
added a commit
that referenced
this pull request
Jan 21, 2026
# XIOS: Separate out testing of restarts and diagnostics Fixes #977 Fixes #1003 Refinement of #1002 ### Task List - [x] Defined the tests that specify a complete and functioning change (*It may help to create a [design specification & test specification](../../../wiki/Specification-Template)*) - [x] Implemented the source code change that satisfies the tests - [x] Documented the feature by providing worked example - [x] Updated the README or other documentation - [x] Completed the pre-Request checklist below --- # Test Description This PR separates the XIOS reading and writing tests out by type. In addition, we add a read test for the diagnostic outputs and check that they are time-averaged. --- # Change Description Code changes are made to account for the case where only one XIOS domain is used when writing. This is required due to an unfortunate consequence of the way XIOS appends the domain name only if there are two or more domains. In detail: if only one domain type is used then the output file will use `x` and `y` dimensions, rather than the versions appended with `_<dimName>`. We account for this by assuming that `x` and `y` imply `x_dim` and `y_dim` if encountered in an input file. --- # Documentation Impact n/a --- ### Pre-Request Checklist - [x] 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 - [x] No new warnings are generated - [x] Methods and Tests are commented such that they can be understood without having to obtain additional context - [x] This PR/Issue is labelled as a bug/feature/enhancement/breaking change - [x] This change conforms to the conventions described in the README
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
File behaviour for restarts and diagnostics (take 2)
Fixes #935
Fixes #977
Fixes #997
Fixes #898
Fixes #933
Fixes #1003
Makes #967 redundant
Task List
Change Description
This PR fixes several things related to how restarts and diagnostics are configured with XIOS:
xandydimensions, rather than the versions appended with_<dimName>. We account for this by assuming thatxandyimplyx_dimandy_dimif encountered in an input file.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
Both read and write tests are separated out for reading of different file types. This is what accounts for most of the lines changed.
Tests are updated to account for the new behaviour.
I decided to drop
XiosFile_testbecause it is no longer needed. This meant that we could drop the annoyingunittestspecial case.Documentation Impact
The XIOS documentation page has been updated accordingly.
Pre-Request Checklist