Staged cable improve resubmission and restart handling

[Whyborn]

Improvements to staged_cable driver

I made some improvements to the staged_cable driver to hopefully make it more easily understandable, and more easily shareable. Summary of changes:

• Changed the way older restarts are handled. Previously, when setting up the current work directory, we would also run through older restart directories to retrieve any "unique" restarts (any with file name not matching a current restart). I've changed it so that at the end of a stage, we grab any "unique" restart from the previous restarts and copy it into the current restart work directory. Quick example: we've finished stage 1, which created restarts climate_rst.nc and cable_rst.nc, which live in {archive}/restart000. We run stage 2, which created restarts casa_rst.nc and cable_nc.nc. We look back at {archive}/restart000, see that there's no new version of climate_rst.nc, so copy that to the work restart directory. The contents of the work restart directory are then moved to {archive}/restart001. This makes restarts much more easily shareable.
• Changed the way the remaining number of runs are set. Previously, on initialisation of the model, the configuration log was read and the environment variable dictating the number of runs was modified. I realised I can set expt.n_runs instead of the environment variable, which is persistent. Now the configuration log work is only done where necessary in setup() and archive```, rather than every initialisation.

Coming with this is the removal of a fair bit of now-dead code.

Edit: One thing I forgot to mention is the handling of potentially new namelists. I would like it to be possible for people adding new science (or perhaps cable configurations I don't know about yet) to be able to use the tool. Unfortunately, I can't know a priori which namelists will be required in these instances. To get around this, I could simply set

self.optional_config_files = glob.glob('*/nml')

rather than the predefined list of namelists, but it feels like a bit of an abuse of process. Thoughts?

[pep8speaks]

Hello @Whyborn! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers:

Comment last updated at 2024-11-12 02:23:46 UTC

[coveralls]

coverage: 58.775% (+0.4%) from 58.364% when pulling b69b26d331a49b40f7acd10ffd7976b2e3599da9 on staged-cable-improve-resubmission-and-restart-handling into 27aac372dba2752e1d58ab1d66db799e7891e103 on master.

[aidanheerdegen]

I wanted to add Claire to the reviewers, but she doesn't appear in the list of reviewers.

I've made a team for ACCESS-NRI and this is rectified