|
| 1 | +# Apptainer and Environment Modules |
| 2 | + |
| 3 | +On the new platform, environment modules integrate with Apptainer to provide consistent, containerized runtimes for HPC applications. When you `module load` an application, the module system: |
| 4 | + |
| 5 | +- Resolves and loads required dependencies (e.g., `gcc`, `mpi`) |
| 6 | +- Sets per-application environment variables (e.g., `$EXEC_CMD_VASP`, `$EXEC_CMD_QE`) |
| 7 | +- Updates a convenience variable `$EXEC_CMD` to the most recently loaded application's command |
| 8 | +- Maintains `$EXEC_CMDS` as a colon-separated list of loaded application exec variables (e.g., `EXEC_CMD_VASP:EXEC_CMD_QE`) |
| 9 | + |
| 10 | +## Example session |
| 11 | + |
| 12 | +```bash |
| 13 | +>>>> module load espresso/6.3-gcc-openmpi-openblas |
| 14 | +The module gcc/11.2.0 is loaded |
| 15 | +The module mpi/ompi-4.1.1 is loaded |
| 16 | +The module espresso/6.3-gcc-openmpi-openblas is loaded |
| 17 | + |
| 18 | +Loading espresso/6.3-gcc-openmpi-openblas |
| 19 | + Loading requirement: gcc/11.2.0 mpi/ompi-4.1.1 |
| 20 | + |
| 21 | +>>>> echo $EXEC_CMD |
| 22 | +apptainer exec --bind /export,/scratch,/dropbox,/cluster-001-share \ |
| 23 | + /export/compute/software/applications/espresso/6.3-gcc-openmpi-openblas/image.sif |
| 24 | + |
| 25 | +>>>> echo $EXEC_CMDS |
| 26 | +EXEC_CMD_QE |
| 27 | + |
| 28 | +>>>> echo $EXEC_CMD_QE |
| 29 | +apptainer exec --bind /export,/scratch,/dropbox,/cluster-001-share \ |
| 30 | + /export/compute/software/applications/espresso/6.3-gcc-openmpi-openblas/image.sif |
| 31 | + |
| 32 | +>>>> module load vasp/5.4.4-gcc-openmpi-openblas-fftw-scalapack |
| 33 | +The module vasp/5.4.4-gcc-openmpi-openblas-fftw-scalapack is loaded |
| 34 | + |
| 35 | +>>>> echo $EXEC_CMDS |
| 36 | +EXEC_CMD_VASP:EXEC_CMD_QE |
| 37 | + |
| 38 | +>>>> echo $EXEC_CMD |
| 39 | +apptainer exec --bind /export,/scratch,/dropbox,/cluster-001-share \ |
| 40 | + /export/compute/software/applications/vasp/5.4.4-gcc-openmpi-openblas-fftw-scalapack/image.sif |
| 41 | + |
| 42 | +>>>> echo $EXEC_CMD_VASP |
| 43 | +apptainer exec --bind /export,/scratch,/dropbox,/cluster-001-share \ |
| 44 | + /export/compute/software/applications/vasp/5.4.4-gcc-openmpi-openblas-fftw-scalapack/image.sif |
| 45 | +``` |
| 46 | + |
| 47 | +Notes: |
| 48 | +- The Apptainer command binds common platform directories into the container (e.g., `/export`, `/scratch`, `/dropbox`, and the cluster share such as `/cluster-001-share`). |
| 49 | +- `$EXEC_CMD` always points to the last loaded application's container exec command. |
| 50 | +- Use per-app variables (e.g., `$EXEC_CMD_VASP`, `$EXEC_CMD_QE`) when you need to be explicit in job scripts. |
| 51 | + |
| 52 | +## Using in job scripts |
| 53 | + |
| 54 | +See: |
| 55 | +- [Jobs via Command Line](../overview.md) |
| 56 | +- [Batch Scripts > General Structure](general-structure.md) |
| 57 | +- [Batch Scripts > Sample Scripts](sample-scripts.md) |
0 commit comments