Skip to content

Commit

Permalink
Refactor the section for snakemake config
Browse files Browse the repository at this point in the history
  • Loading branch information
xies4 committed May 1, 2024
1 parent 8b07d8b commit 7f556c2
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 19 deletions.
18 changes: 0 additions & 18 deletions docs/pipeline_containerization.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,3 @@ Rscript {analysis}/workflow/scripts/rna/sc_seurat.prod.R --genome={config.ref} -
"""
```


The configuration of snakemake command for singularity can be found in `profile/slurm/config.v8+.yaml`:

```
use-singularity: True
singularity-args: ' "--cleanenv --no-home -B /scratch/ccrsf_scratch -B /mnt/ccrsf-static -B /mnt/ccrsf-ifx -B /mnt/ccrsf-raw -B /mnt/ccrsf-active" '
```

The option `-B` is used to bind the corresponding storage space into the container so that the files from scratch/Qumulo can be accessible from inside the container.

`--no-home`: no host `$HOME` directory mounting.
> Auto-binding feature: By default, Singularity automatically binds several directories (e.g.: `$HOME`, `$PWD`) and in particular it binds the home folder of the host. This features simplifies the usage of Singularity for the users, however it can also lead to unexpected behaviours and frustration. For example, if you have different python packages installed in your host home directory and in the container the host packages maybe used instead f the container ones. To avoid this issue, `--no-home` is used.
The `--cleanenv` option is used to exclude passing EBV variables frin the host into the container.

Similar to `--no-home`, `--cleanenv` is used to disable Singularity passing host environment variables (`$PATH`, `$LD_LIBRARY_PATH`, etc) to the container.


2 changes: 1 addition & 1 deletion docs/snakemake_opt4singularity.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The configuration of snakemake command for singularity is recommended to set up in `profile/slurm/config.v8+.yaml`:
The configuration of snakemake command for singularity is recommended to be set up in `profile/slurm/config.v8+.yaml`:

```
use-singularity: True
Expand Down

0 comments on commit 7f556c2

Please sign in to comment.