From 1a50fedfd452c1e26f94e9ba80772c0f655862a7 Mon Sep 17 00:00:00 2001 From: Jo Basevi Date: Mon, 16 Sep 2024 11:16:04 +1000 Subject: [PATCH] Update docs config.rst: Add payu_minimum_version --- docs/source/config.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/config.rst b/docs/source/config.rst index 72636235..b9482908 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -573,3 +573,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`. \ No newline at end of file