Add cmd-line flag to disable metadata + UUID generation and commits

payu-org / payu

A workflow management tool for numerical models on the NCI computing systems

Apache License 2.0

21 stars 27 forks source link

Add cmd-line flag to disable metadata + UUID generation and commits #447

Closed jo-basevi closed 3 months ago

jo-basevi commented 5 months ago

Add cmd line flag --metadata-off/-M (better names?) to payu subcommands to disable metadata files or UUIDs being created. This uses control directory for experiment names. (so equivalent to metadata: enable: false in config.yaml)

Added this flag to sub-commands that create an Experiment class instance - so archive, collate, profile, run, setup, sweep and sync.

Closes #446

pep8speaks commented 5 months ago

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

In the file payu/subcommands/args.py:

Line 289:2: W292 no newline at end of file

Comment last updated at 2024-08-22 04:01:06 UTC

coveralls commented 3 months ago

coverage: 56.434% (+0.2%) from 56.234% when pulling c2d10c3e5382e9f1ac0afcda5620dcd87105558b on ACCESS-NRI:446-add-cmd-line-arg-to-disable-metadata into fcd414b3c5f775aa5e2158861b6e8a9bb49aecb8 on payu-org:master.

jo-basevi commented 3 months ago

As the intention was to add a command-line argument to make it easier to update manifests for released configurations, running payu setup (and maybe payu sweep) would be the only commands required to have --metadata-off. If wishing to disable metadata for payu run/sync/collate jobs using the metadata: enable: false in config.yaml would be the best option. So that simplifies this PR quite a bit!