Description
Currently one can specify a restart file when cloning a payu configuration or inserting this information under restart: in the config.yaml. I really like this feature!
What is potentially confusing is that whilst one specifies this the first time when cloning this switch is not picked up again if there are restarts files available in the archive folder. The key code (thanks @dougiesquire!) is here. In other words, there's a gotcha where a user (i.e. Dougie and I!) can be confused as to why one does not need to update the restart: part of the config.yaml on subsequent runs. Now, this is beautifully explained in the Payu docs:
restart
Specify the full path to a restart directory from which to start the run. This is known as a “warm start”. This option has no effect if there is an existing restart directory in archive, and so does not have to be removed for subsequent submissions.
But this is coming up in several places in the hive docs, namely how to run om2, esm1.5 and om3. As well as this upcoming PR for om2 where this exact issue is relevant.
So @ACCESS-NRI/webops, can something like the payu docs information please be added to the above four examples?
(Sidenote: would be great to have some general payu training on the hive docs... e.g. great resources already exist!)
ping'ing @atteggiani @heidinett @paigem @KAUR1984 @jo-basevi @aidanheerdegen