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 docs on model executable loaded via environment modules #519

Merged
merged 1 commit into from
Sep 29, 2024
Merged
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
18 changes: 12 additions & 6 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,12 @@ configuration.
directory of the list takes precedence.

``exe``
Binary executable for the model. This can either be a filename in the
laboratory's ``bin`` directory, or an absolute filepath. Various model
drivers typically define their own default executable names.
Binary executable for the model. This can be a filename or an absolute
filepath. If it's a filename, it needs be found in either the laboratory's
``bin`` directory, or in paths added to ``$PATH`` by loaded environment
modules (see configuring :ref:`modules<configuring-modules>` for how to load
modules).
Various model drivers typically define their own default executable names.

``submodels``
If one is running a coupled model containing several submodels, then each
Expand Down Expand Up @@ -551,6 +554,7 @@ Miscellaneous
Ignore any restart files and repeat the initial run upon resubmission. This
is generally only used for testing purposes, such as bit reproducibility.

.. _configuring-modules:
``modules``
Specify lists of environment modules and/or directories
to load/use at the start of the PBS job, for example::
Expand All @@ -563,9 +567,11 @@ Miscellaneous
- parallel-netcdf-1.12.3
- xerces-c-3.2.3

This is seldom needed, because payu is good at automatically determining
the environment modules required by model executables. If the modules
require `module use` in order to be found, this command can also be run
As environment modules can be used to determine model executable paths,
the modules loaded are required to be unique. This means modules should be
specified with a version, and modules of the same name and version
should not be found in multiple module directories.
If the modules require `module use` in order to be found, this command can also be run
prior to `payu run` instead of listing the directory under the `use` option,
e.g.::

Expand Down
Loading