Skip to content

Commit b15f5a2

Browse files
committed
Update containerization docs
1 parent 594f848 commit b15f5a2

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,15 @@ and performs the analysis in a single step:
3636

3737
The workflow is compatible with both local execution and HPC environments utilizing SLURM.
3838
The latter requires installing the [Snakemake executor plugin for SLURM](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/slurm.html).
39-
It supports dependency management through either conda or Singularity, as detailed in the
39+
It supports dependency management through either conda or Apptainer/Singularity, as detailed in the
4040
[run modes documentation](config/README.md#run-modes).
4141

42-
We use continuous integration (CI) to verify that all dependencies install correctly
42+
We use continuous integration (CI) to automatically verify that all dependencies install correctly
4343
with Snakemake v7.32.4 (see GitHub Action `Install`), and to test that VIPERA runs
44-
successfully with Snakemake v7.32.4, v8.30.0, and v9.1.6 (see GitHub Actions
45-
`Test Sm v[7-9]`).
44+
successfully with Snakemake v7.32.4, v8.30.0, and v9.1.6 using conda (Actions `Test Sm v[7-9]`).
45+
We also test a containerized workflow with Snakemake v9.1.6 and Apptainer using a
46+
[remote image](https://hub.docker.com/r/ahmig/vipera) (Action `Test Sm v9 Apptainer`).
47+
This image is automatically updated in every version (Action `Deploy`).
4648

4749
Please refer to the [**full workflow documentation**](config/README.md) for detailed instructions.
4850

config/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,12 +183,12 @@ snakemake --use-conda --slurm --profile profile/default
183183

184184
Additionally, we offer the option of running the workflow within a containerized
185185
environment using a [pre-built Docker image](https://hub.docker.com/r/ahmig/vipera),
186-
provided that [Singularity](https://en.wikipedia.org/wiki/Singularity_(software))
186+
provided that [Apptainer/Singularity](https://en.wikipedia.org/wiki/Singularity_(software))
187187
is available on the system. This eliminates the need for further conda package
188188
downloads and environment configuration.
189-
To do that, simply add the option `--use-singularity` to any of the previous commands.
189+
To do that, simply add the option `--use-apptainer` to any of the previous commands.
190190

191-
Using Singularity for running VIPERA in the Windows Subsystem for Linux (WSL)
191+
Using Apptainer for running VIPERA in the Windows Subsystem for Linux (WSL)
192192
may encounter errors due to the default file permissions configuration, which
193193
conflicts with Snakemake's containerized conda environment activation mechanism.
194194
Thus, running the containerized VIPERA workflow on the WSL is not advised.

0 commit comments

Comments
 (0)