Skip to content

Commit

Permalink
Update docs config.rst: Add payu_minimum_version
Browse files Browse the repository at this point in the history
  • Loading branch information
jo-basevi committed Sep 16, 2024
1 parent ddaab9c commit 0ff4be5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -571,3 +571,11 @@ Miscellaneous

module use /path/to/module/directory
payu run

``payu_minimum_version``
Specify the minimum version of payu required to run the configuration.
At the start of experiment setup, payu checks whether its current version
is an earlier version, and if so, payu will refuse to run.
This is useful for models that require features that are in later versions
of payu.
Note that this check will only run with payu versions later than `1.1.5`.

0 comments on commit 0ff4be5

Please sign in to comment.