search

COSIMA / access-om3

ACCESS-OM3 global ocean-sea ice-wave coupled model
13 stars 7 forks source link

Use `payu clone` in docs #221

Open aekiss opened 2 months ago

aekiss commented 2 months ago

Documentation should be updated to use payu clone:

anton-seaice commented 1 month ago

See https://github.com/ACCESS-NRI/access-om3-wav-configs/pull/50#discussion_r1751277353 and https://github.com/ACCESS-NRI/access-om3-wav-configs/pull/50#discussion_r1751278510 for suggestions on updates to the README.md.

aidanheerdegen commented 1 month ago

Re runlog

In these configs, it is false currently (or should be)

Is the intention for this to be the case into the future?

anton-seaice commented 1 month ago

Re runlog

In these configs, it is false currently (or should be)

Is the intention for this to be the case into the future?

No its just for convenience.

When release time comes, this needs changing to runlog:True

(when there is a payu run --no-runlog we can probably change it also)

aidanheerdegen commented 1 month ago

No its just for convenience.

Whose convenience?

Just trying to get at the motivation. If we really want users to have this switched on then I think we should set it to be True by default. The downside is for devs who forget to turn it off, but the downside there is just a rebase and drop some commits. A user who forgets to turn it on can't magically make commits appear that never existed.

aekiss commented 1 month ago

I agree this should be True when production-intent configs are released, but in the meantime False is more convenient for developers.