Skip to content

Commit 5dad347

Browse files
committed
chore: add apptainer descrtipion
1 parent f877d1c commit 5dad347

File tree

4 files changed

+72
-0
lines changed

4 files changed

+72
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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)

lang/en/docs/jobs-cli/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ We describe the accounting aspects of Job submission via CLI, such as specifying
1414

1515
The actions pertaining to Jobs submission and execution under the CLI are reviewed [in this section](actions/overview.md) of the documentation. Other general actions concerning the CLI, such as the loading of modules, the compilation of new applications or the creation of new python environments, are described [separately](../cli/actions/overview.md).
1616

17+
## Apptainer and Environment Modules
18+
19+
For the new platform, CLI workflows use Apptainer-backed modules that set `$EXEC_CMD` variables for containerized execution. See: [Apptainer and Environment Modules](batch-scripts/apptainer.md)
20+
1721
## [Tutorials](../tutorials/jobs-cli/overview.md)
1822

1923
We provide tutorials guiding the user through the complete procedure for submitting jobs via CLI, and subsequently retrieving the corresponding results under the [Web Interface](../ui/overview.md) of our platform. These tutorials are introduced [here](../tutorials/jobs-cli/overview.md).

lang/en/docs/migrating-to-new-platform.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,16 @@ You can sign in to the new platform with the same credentials you use for the cu
7676
4. Contact us for assistance with bulk data migration and best practices
7777
5. Validate your workflows on the new clusters (e.g., `cluster-001`, `cluster-002`, `cluster-003`, `cluster-101`)
7878

79+
## CLI and Environment Modules with Apptainer
80+
81+
See examples of module loading, `$EXEC_CMD`, and containerized execution in: [Apptainer and Environment Modules](jobs-cli/batch-scripts/apptainer.md)
82+
83+
### Using in job scripts
84+
85+
As below:
86+
87+
```
88+
7989
## Contact and Support
8090
8191
- For migration help (data movement, cluster selection, workflow updates), contact your Mat3ra representative or reach us via Support Widget in the platform header or `[email protected]`.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,7 @@ nav:
628628
- General Structure: jobs-cli/batch-scripts/general-structure.md
629629
- Directives: jobs-cli/batch-scripts/directives.md
630630
- Working Directory: jobs-cli/batch-scripts/directories.md
631+
- Apptainer & Environment Modules: jobs-cli/batch-scripts/apptainer.md
631632
- Sample Scripts: jobs-cli/batch-scripts/sample-scripts.md
632633
- Actions:
633634
- Overview: jobs-cli/actions/overview.md

0 commit comments

Comments
 (0)