Payu: a workflow manager for some ACCESS models

26/08/2026

:rocket: Release: 1.3.5

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

Getting Started

This version of payu is now available on gadi:

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

Updates

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

Notes

1. Support relative path for restarts in config.yaml

From payu 1.3.5, the restart directory can be provided as a relative path in config.yaml. Payu will resolve the relative path to an absolute path and find the files.

2. payu clone supports changing project and branch-supplied URL

Based on community feedback, we add a new prompt in payu clone interactive mode:

>> Do you want to override the shortpath? (Default is '/xxx/yy')
    yes
    no

Selecting yes allows user to override the shortpath and specify a desired project.

payu clone interactive mode also supports branch-supplied URL (e.g., https://github.com/ACCESS-NRI/access-esm1.6-configs/tree/release-piControl), which will be convenient for beginners. Branch-supplied URLs are only supported in interactive mode and are not supported by non-interactive payu clone.

3. Parent experiment time and commit hash are added to metadata

When checking out a new branch, payu now records the following parent information in metadata.yaml:

  • parent_experiment: The UUID of the parent experiment, if this experiment branches from another.
  • parent_experiment_branch_time: The model time corresponding to the restart path used to create this branch, if restart path is provided.
  • parent_experiment_branch_commit: The Git commit hash of the source branch when the new branch was created.

Please see payu documentation for details on each field in metadata.yaml.

4. After payu sweep --hard, payu setup no longer requires --new-uuid flag

Since payu 1.3.4, payu setup requires explicit confirmation before generating a new archive and new UUID, using the --new-uuid flag.

From payu 1.3.5, payu sweep --hard sets the UUID to uuid-swept-by-hard-sweep. When payu detects this UUID, payu setup will not require the --new-uuid flag before generating a new archive directory and new UUID. This is based on the assumption that users want to start a new experiment after calling payu sweep --hard.

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

Developments by @Qianhui_Chen, @minghangli, @Aidan.

Reviewers included @jo-basevi, @Aidan, @jasmeen_kaur, @ben.