LFRic Apps Release#

LFRic Inputs KGO Install#

  • This can be done at any point once all PRs that change lfricinputs kgo have been committed.

  • It’s easiest to use the umtest nightly testing for this and will save having to run the suite twice.

  • Alternatively, run cylc vip -z g=lfricinputs -S HOUSEKEEPING=false -n lfricinputs_kgo ./rose-stem and wait for this to finish - all jobs should pass.

  • Install the kgo by running $UMDIR/SimSys_Scripts/kgo_updates/meto_update_kgo.sh --new-release

    • The script will ask for a clone path - this can be any lfric apps clone as it will not be modified.

    • The version number and PR number are not used, although an entry is required.

    • The kgo install directory must be updated to vnX.Y

LFRic Release#

  • Ensure you have a fork of both the lfric_apps and lfric_core repositories, and that the main branches in each are up to date with the upstream repository.

  • Create an LFRic Apps Issue for the release to provide a number for the release script.

  • In a clone of these forks, create a branch using the main branch as the parent.

Important

Ensure you create branches from main, otherwise you will not include the changes from the past release.

  • Move into the lfric apps clone

  • Run the release script, $UMDIR/SimSys_Scripts/lfric_macros/release_lfric.py -o A.B -v X.Y -t TTTT -c /path/to/core

    • A.B - the previous version

    • X.Y - the new version

    • TTTT - the apps release issue number

    • /path/to/core - path to the lfric core clone

  • Check the output looks sensible. It should:

    • Update the version number

    • Revert any changes to rose-stem/site/meto/variables_*.cylc

    • Copy the HEAD metadata to vnX.Y

    • Add a blank upgrade macro to all versions.py files

    • Apply the upgrade macro - rose apps should be updated to the new version

    • Add a version_ab_xy.py upgrade file - a copy of the versions.py file

    • Reset the versions.py file with no upgrade macros

  • Tag other repositories and update dependencies.yaml:

    • Ensure that the other repositories have all been tagged.

    • In dependencies.yaml:

      • Ensure the lfric_core source is pointing at the local clone of your branch.

      • Update ref for all other repositories to be the Simulation Systems tag YYYY.MM.1, checking that the dependencies look as they should.

  • Commit your changes to both Apps and Core branches.

  • Run the test suites

    • cylc vip -z g=all -n lfric_*X.Y ./rose-stem for both Apps and Core.

  • Once testing is complete, update LFRic Core in dependencies.yaml

    • source should be the MetOffice ssh url

    • ref should be coreX.Y

  • Open a PR for each and with a reviewer, follow the review process