21/04/2026
Release: 1.3.0
https://github.com/payu-org/payu/releases/tag/1.3.0
Getting Started
This version of payu is now available on gadi:
module use /g/data/vk83/modules
module load payu/1.3.0
Updates
PBS job names for user postscript are now standardised to payu_postscript. payu sweep also cleans up postscript log files ( #682).
Adds base_path as a fallback when path is not set in sync. The full sync destination becomes base_path/experiment_name/( #670).
Hidden files and directories are now excluded in manifests by default. To include them, please set ignore to an empty list [] in config.yaml ( #677).
An interactive mode for payu clone setup (#703).
Display current/total PBS queue time in payu status --update (#686).
Experiment time (e.g., 1900-01-03T00:00:00) tracking in payu status( #702).
Cleaner warning message with stacktrace set to false by default. To see full details, please use flag --stacktrace(#713).
A new payu support command to display your computing environment and machine configuration (#710).
For a full list of pull requests that includes additional bug fixes, please see Payu Github 1.3.0 release.
Notes
1. Payu clone interactive mode
You now can run
payu clone
to launch an interactive wizard that guides you through the cloning process. The wizard:
- provides live searching of remote branch names
- autocompletes existing directory names
- adapts follow-up questions based on your previous inputs.
A flowchart of all interactive prompts is available on ReadTheDoc.
Example:
Previously, to clone an ACCESS-ESM1.5 configuration from branch release-preindustrial+concentrations, into a local directory (preindustrial_concen) and name the local branch as expt1, we need
payu clone -b expt1 -B release-preindustrial+concentrations https://github.com/ACCESS-NRI/access-esm1.5-configs preindustrial_concen
Now you can achieve the same result using the interactive payu clone:
2. A more informative payu status
Now we can check how long a payu PBS job has been in queue by running:
payu status --update
For running PBS jobs, a total queued time is displayed.
Meanwhile, we can also track the progress of a payu run with
payu status
This displays the current experiment time for running jobs and model finish time for archived jobs. This feature is currently supported for:
- ACCESS-OM2
- ACCESS-OM3
- ACCESS-ESM1.5
- ACCESS-ESM1.6
- MOM6
3. Easier support and debugging
The new support command
payu support
provides useful diagnostic information, including:
- Payu version and installation path.
- Python version and the full system path where packages are loaded from.
- Loaded modules (e.g., PBS).
- Machine information, such as the Operating System and CPU architecture.
This information will be helpful in debugging environment issues or providing necessary details when reporting an issue.
4. Cleaner warning messages
In the latest payu, warning messages are displayed in a cleaner format with no stack trace by default. To see the full details, please use --stacktrace flag.
Example:
$ payu status
[WARNING] Example of warning messages.
$ payu status --stacktrace
[WARNING] /home/$USER/payu/subcommands/status_cmd.py:35: UserWarning: Example of warning messages.
warnings.warn("Example of warning messages.")
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 were by @Qianhui_Chen, @minghangli, @jasmeen_kaur.
Reviewers included @jo-basevi, @Aidan, @spencerwong, @anton, @manodeep, @lachlanswhyborn.