Payu: a workflow manager for some ACCESS models

ACCESS-NRI Releases
, , ,
7

03/02/2025

:rocket: Release: 1.1.6

https://github.com/payu-org/payu/releases/tag/1.1.6

Getting Started

This version of payu can now be accessed on gadi:

module use /g/data/vk83/modules
module load payu/1.1.6

Updates

:white_check_mark: Fix default shortpath project bug (#504)
:white_check_mark: Add minimum payu version config.yaml option (#511)
:white_check_mark: Support symbolic links in input files (#518)
:white_check_mark: Add command line option for payu clone to start from commit hash/tag (#515)
:white_check_mark: Support relative restart paths with payu clone command (#516)
:white_check_mark: ACCESS-OM3: Add checks of input/output parallel processor layout to cmeps driver used for ACCESS-OM3 (#496)
:white_check_mark: CABLE: Add staged driver for CABLE configurations (#461)
:white_check_mark: CICE5: Don’t require cice_in.nml namelist in restarts - this fixes errors when starting from ACCESS-OM2 restarts (#507)
:white_check_mark: CICE5: Fix restart pointers (#535)
:white_check_mark: CICE4: Add log file compression (#532 and #542)
:white_check_mark: CICE4: Check restart file dates (#539)

For a full list of pull requests that includes additional bug fixes, see the Payu Github 1.1.6 release.

Notes

Containerised conda environment

The conda environment for payu/1.1.6 now runs inside a singularity container. The deployment is based on the work done by CLEX CMS on Containerised Conda environments. This dramatically reduces the inode usage of each conda environment as the environment is compressed into a SquashFS file that is added as an overlay to a singularity container at runtime.

If there are problems with running commands once the payu module is loaded, please create an issue on the ACCESS-NRI/model-release-condaenv repository.

Model log compression option for CICE4

CICE4 model log files can take up a significant amount of storage. By default payu now compresses some log files into a tarball during archival.

No changes are necessary to enable this option, but it can be configured in config.yaml under the archive section, e.g.

archive:
  compress_logs: false # Default is true

Currently log file compression is only implemented for the CICE4 model.

Added Beta CABLE driver

Added a driver for running multi-stage CABLE configurations. Supports arbitrary spin-up configurations through the staged_cable driver. See the cable-offline-configs for instructions on using the driver. Driver internals are still being iterated, but user experience should remain consistent.

Payu clone/checkout updates

With the payu clone command, to create a new git branch starting from a specific git tag or commit, use -s/--start-point flag:

payu clone -b <NEW_BRANCH> -s <COMMIT_HASH|TAG> <REPOSITORY_URL> <EXPERIMENT_NAME>

When checking out a new branch starting from a restart directory, a relative path can now be used, e.g.:

payu checkout -b expt -r archive/restart002

Previously the full path to the restart directory was required.

Payu minimum version

As some configurations might require features in later versions of payu to run, there’s an config.yaml option to set a minimum version of payu:

payu_minimum_version: 1.1.6

This will run a check at the start of payu setup to compare this version with the currently running payu version. Note that this check will only run with payu versions >=1.1.6 so it will be more useful in the future once there are more versions of payu available that support this feature.

Support

Replies to this topic are disabled.

If you have specific questions about this release follow the guidelines for requesting help from ACCESS-NRI.

If you have questions about payu create a topic in a category that best matches the model you are using, or in the Technical category and tag it with payu. If you require assistance follow the guidelines for requesting help from ACCESS-NRI.

Credits

Development was by @jo-basevi, @anton, @spencerwong and @lachlanswhyborn.

2 Likes