Radaer api la side - part two initialisation

[Alan J Hewitt (alanjhewitt)]

PR Summary

Sci/Tech Reviewer:
Code Reviewer:

I developed the original lfric to radaer functionality in 2020. Like a lot of developments back then, it was needed in a hurry and so I developed a fudged solution with technical debt.

We will need user flexibility soon to be able to run radaer with different user settings, hence this part two of two development.

In part two, the previously hard coded lists (from part one) are instead generated from user settings based on the value of i_mode_setup if running with setting "ukca". For settings "glomap_clim" and "dust_and_clim", the user is not allowed to set i_mode_setup as this will always be setting "8" aka SUBCOCSSDU7mode.

These lists are to be determined during the initialisation step and saved for the rest of the run.

I will also include some documentation to describe the RADAER API.

• linked Radaer api ukca side - part two initialisation ukca#45

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

[James Bruten (james-bruten-mo)]

Given the metadata changes, this is the only file where you should add an upgrade macro. When apply_macros.py gets run, it will copy the macro to all relevant places based on the metadata inheritance. Please revert all the other changes to versions.py files.

LFRic macro guidance: https://metoffice.github.io/simulation-systems/Development/macros.html#upgrade-macros-in-lfric

[Alan J Hewitt (alanjhewitt)]

Commands used to make test branch and run upgrade macro

! create test branch locally
git switch -c BoB_radaer_api_la_side_5n

module load scitools

/home/users/umadmin/SimSys_Scripts/lfric_macros/apply_macros.py vn3.2_t698

! if I mess up run this
git restore .

! push change back to Github
git commit -a
git push --set-upstream origin BoB_radaer_api_la_side_5n

cylc vip -z group=developer -n BoB_radaer_api_la_side_5n ./rose-stem
! or
cylc vip -z group=all -n BoB_radaer_api_la_side_5n ./rose-stem