Skip to content

Commit 4c336a6

Browse files
author
Natalie Perlin
committed
Corrected and updated ContainerQuickstart.rst
1 parent f91165c commit 4c336a6

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

doc/UsersGuide/BuildingRunningTesting/ContainerQuickstart.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,13 +179,25 @@ load before building or running the container.
179179
* - Hercules/Orion
180180
- ``singularity``
181181
- ``module load singularity``
182+
* -
183+
- ``apptainer`` (*)
184+
- ``module load spack-managed-x86-64_v3/v1.0 apptainer``
182185
* - Derecho
183186
- ``apptainer``
184187
- ``module load apptainer``
185188
* - NOAA Cloud AWS/Azure
186189
- ``singularity``
187190
- none required
191+
192+
(*) - The ``apptainer`` module on Hercules/Orion is a Spack-managed
193+
install that loads a separate environment, which may not combine well
194+
with other system modules. The ``apptainer`` enables certain container
195+
build features
196+
that are otherwise limited in ``singularity`` module by security
197+
constraints. The ``singularity`` module could further be used for compile
198+
and runtime environments.
188199

200+
189201
.. _CompilerMPIReqC:
190202

191203
Compiler and MPI Requirements
@@ -650,14 +662,15 @@ instructs otherwise.
650662

651663
.. code-block:: console
652664
653-
singularity build -B </top_dir> -B </bind_add> --sandbox --fix-perms rocky9-oneapi2024.2-ss192 \
665+
singularity build --sandbox --fix-perms rocky9-oneapi2024.2-ss192 \
654666
docker://noaaepic/rocky9-oneapi2024.2-spack-stack:v1.9.2-ufs-wm-env
655667
656668
#. Copy the helper scripts, *intel-sandbox.sh* and *compilers_cp.sh* out of the sandbox.
657669

658670
.. code-block:: console
659671
660-
singularity exec rocky9-oneapi2024.2-ss192 cp /opt/*.sh .
672+
singularity exec rocky9-oneapi2024.2-ss192 cp /opt/intel-sandbox.sh .
673+
singularity exec rocky9-oneapi2024.2-ss192 cp /opt/compilers_cp.sh .
661674
662675
These scripts retrieve the Intel compiler and MPI components and reinstall
663676
them for use with the software-stack sandbox.
@@ -696,7 +709,7 @@ instructs otherwise.
696709

697710
.. code-block:: console
698711
699-
singularity build -B /<top-level-dir> --fix-perms rocky9-oneapi2024.2-ss192.sif \
712+
singularity build --fix-perms rocky9-oneapi2024.2-ss192.sif \
700713
rocky9-oneapi2024.2-ss192
701714
702715
After the image is built successfully, the sandbox can be removed. Finally,

0 commit comments

Comments
 (0)