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
Show file tree
Hide file tree
Changes from all 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
28 changes: 13 additions & 15 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,24 +351,21 @@ 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 :ref:`stages<experiment-steps>` 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 exceptions to
this are when ``payu setup`` is called directly, then the relevant userscripts
will run on the login node, and the ``sync`` userscript, which runs in the
``sync`` job.

Specific scripts are defined below:
Specific stages are defined below:

``init``
User-defined command to be called after experiment initialization, but
Expand All @@ -391,9 +388,10 @@ Postprocessing
returns an error code. Useful for automatic error postmortem.

``sync``
User-defined command to be called at the start of the ``sync`` pbs job.
This is useful for any post-processing before syncing files to a remote
archive.
User-defined command to be called at the start of the ``sync`` PBS job.
This is useful for any post-processing before syncing files to a remote
archive. Note these scripts are only run if automatic syncing is enabled
or if payu sync is run manually.

``postscript``
This is an older, less user-friendly, method to submit a script after ``payu``
Expand Down
21 changes: 21 additions & 0 deletions docs/source/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,27 @@ Work Path
Experiments that are actively running are stored in the work path. For an
experiment named ``myrun``, the default directory is ``${LAB}/work/myrun``.

.. _experiment-steps:
Experiment Steps
================

Payu runs through several steps to setup, run and clean-up an experiment, outlined below:

init
Experiment initialization runs first, and includes reading in configuration information and updating the metadata.

setup
Setup creates the ephemeral work directory and updates manifests. It is what is run with the ``payu setup`` command.

run
This is the step which does any automated ``runlog`` commands (``git commit``) and executes the model.

error
The error stage is entered if the model runs but returns an error code.

archive
If the model run is succesful, payu archives the results from the work directory to the output directories.


Style Guide
===========
Expand Down
Loading