Skip to content

Enable lfric_xios_file_type to take configuration from an associated XIOS field group#352

Open
Ed Hone (EdHone) wants to merge 5 commits intoMetOffice:mainfrom
EdHone:351-file-field_group
Open

Enable lfric_xios_file_type to take configuration from an associated XIOS field group#352
Ed Hone (EdHone) wants to merge 5 commits intoMetOffice:mainfrom
EdHone:351-file-field_group

Conversation

@EdHone
Copy link
Copy Markdown
Contributor

@EdHone Ed Hone (EdHone) commented Apr 28, 2026

PR Summary

Sci/Tech Reviewer:
Code Reviewer: mo-marqh

This brings together the use of XIOS field groups within the lfric_xios_file_type. This will enable applications to configure the behaviour of fields within a file, without needing large-scale code changes within the model code itself.

By default an XIOS field group with the ID {FILE_ID}_fields will be created for each file defined with a lfric_xios_file_type object. This default ID can be overwritten by passing the field_group_id argument to the lfric_xios_file_type constructor. If this field group is already defined within an XML configuration it wont be overwritten so any fields contained with that field group can be configured by the model at run time.

I also fixed the iodef files in the lfric-xios integration tests to make them runnable with XIOS 3

closes #351

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 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)

trac.log

Test Suite Results - lfric_core - lfric_core-351-file-field_group/run2

Suite Information

Item Value
Suite Name lfric_core-351-file-field_group/run2
Suite User edward.hone
Workflow Start 2026-04-29T08:50:48
Groups Run developer
Dependency Reference Main Like
lfric_core EdHone/lfric_core@351-file-field_group False
SimSys_Scripts MetOffice/SimSys_Scripts@cab3315 True

Task Information

✅ succeeded tasks - 390

I've also run these changes against lfric_apps

Test Suite Results - lfric_apps - lfric_apps-test_field_groups/run3

Suite Information

Item Value
Suite Name lfric_apps-test_field_groups/run3
Suite User edward.hone
Workflow Start 2026-04-29T09:31:38
Groups Run developer
Dependency Reference Main Like
casim MetOffice/casim@2026.03.2 True
jules MetOffice/jules@2026.03.2 True
lfric_apps EdHone/lfric_apps@test_field_groups False
lfric_core EdHone/lfric_core@351-file-field_group True
moci MetOffice/moci@2026.03.2 True
SimSys_Scripts MetOffice/SimSys_Scripts@cab3315 True
socrates MetOffice/socrates@2026.03.2 True
socrates-spectral MetOffice/socrates-spectral@2026.03.2 True
ukca MetOffice/ukca@1cdb9c2 True

Task Information

✅ succeeded tasks - 1185

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

@EdHone Ed Hone (EdHone) marked this pull request as ready for review April 29, 2026 08:33
@EdHone Ed Hone (EdHone) requested a review from a team as a code owner April 29, 2026 08:33
@EdHone Ed Hone (EdHone) requested review from Andrew Coughtrie (andrewcoughtrie) and removed request for a team April 29, 2026 08:33
@EdHone Ed Hone (EdHone) marked this pull request as draft April 29, 2026 08:36
@EdHone Ed Hone (EdHone) marked this pull request as ready for review April 29, 2026 11:07
@mo-marqh mo-marqh self-requested a review April 30, 2026 13:03
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.

Enable lfric_xios_file_type to make use of existing field_group convention

3 participants