Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update config.rst #489

Merged
merged 9 commits into from
Sep 13, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,22 +351,18 @@ FMS based model only options:
is then ``ncpus / nthreads``


Postprocessing
User Processing
--------------

``collate`` (*Default:* ``True``)
Controls whether or not a collation job is submitted after model execution.

This is typically ``True``, although individual model drivers will often set
the default value to ``False`` if collation is unnecessary.

See above for specific ``collate`` options.

``userscripts``
Namelist to include separate userscripts or subcommands at various stages of
Configure userscripts or subcommands to run at various stages of
a payu submission. Inputs can be either script names (``some_script.sh``) or
individual subcommands (``echo "some_data" > input.nml``, ``qsub
some_script.sh``).
some_script.sh``). Userscripts are run within the same PBS job as the model
execution unless the script starts a new PBS job. Userscripts therefore have
the same compute, storage and network access as the model. The exception to
this is when `payu setup` is called directly, then the relevant userscripts
will run on the login node.
jo-basevi marked this conversation as resolved.
Show resolved Hide resolved

Specific scripts are defined below:
anton-seaice marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Loading