-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
🧩 Feature Request: Add Section on Apptainer
Description
Add a new section to the documentation introducing Apptainer — the container platform designed for high-performance computing (HPC) environments.
This section will guide users on how to build, run, and use Apptainer containers on the Lane cluster for reproducible scientific workflows.
🧭 Suggested Content
- Introduction
- What Apptainer is and how it differs from Docker or Podman.
- Benefits for HPC users: portability, reproducibility, and security.
- Installation / Loading
- How to access Apptainer on the Lane cluster (e.g.,
module load apptainer).
- How to access Apptainer on the Lane cluster (e.g.,
- Basic Commands
- Examples of
apptainer pull,apptainer build, andapptainer run.
- Examples of
- Running Containers
- How to execute applications within containers using local images (
.siffiles) or remote registries.
- How to execute applications within containers using local images (
- Integration
- How Apptainer integrates with Nextflow, Snakemake, and other workflow engines.
- Interaction with Conda and Spack environments.
- Best Practices
- Caching images, managing writable overlays, and working with Lustre or scratch storage.
- Sharing and versioning containers for collaborative projects.
🧪 Expected Outcome
A new subsection under Advanced Topics → Apptainer in the documentation.
Users should be able to:
- Run containerized applications efficiently on the Lane cluster.
- Build reproducible and portable HPC workflows.
- Understand the relationship between Apptainer and other tools like Conda and Spack.
🧰 References
✅ Tasks
- Create
docs/advanced_topics/apptainer.md - Add Apptainer section to
index.rst - Include command examples and workflow integration tips
- Cross-link with Conda and Spack sections
- Build and verify documentation locally
Metadata
Metadata
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation