Skip to content

Commit

Permalink
to expand on #2772, updating instructions to include note to set tmp …
Browse files Browse the repository at this point in the history
…directory for apptainer to prevent issues pulling large images that require a lot of temp space
  • Loading branch information
georgemccabe committed Dec 6, 2024
1 parent 2c4603d commit 42355aa
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/Users_Guide/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -463,10 +463,22 @@ METplus in Apptainer
Apptainer (formerly Singularity) can also be used to run METplus.
Images can be pulled from DockerHub using Apptainer commands.

If running on the NCAR Casper cluster, be sure to first load the Apptainer module via::
If running on the NCAR Casper cluster,
be sure to first load the Apptainer module via::

module load apptainer

It is recommended to set the **APPTAINER_TMPDIR** environment variable to a
directory where the user has write permissions to prevent issues with temporary
files exceeding the size of the /tmp directory.
See the
`Apptainer documentation <https://apptainer.org/docs/user/1.0/build_env.html#temporary-folders>`_
for more information.

Example::

export APPTAINER_TMP_DIR=/d1/${USER}/apptainer_tmp

Navigate to a working directory and pull an image from DockerHub, e.g.::

apptainer pull docker://dtcenter/metplus:5.1-latest
Expand Down

0 comments on commit 42355aa

Please sign in to comment.