Skip to content

Commit

Permalink
Add disclaimer about containerized runs
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmig committed Jan 5, 2024
1 parent 77f3678 commit 75141e6
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,3 +171,11 @@ provided that [Singularity](https://en.wikipedia.org/wiki/Singularity_(software)
is available on the system. This eliminates the need for further conda package
downloads and environment configuration.
To do that, simply add the option `--use-singularity` to any of the previous commands.

Using Singularity for running VIPERA in the Windows Subsystem for Linux (WSL)
may encounter errors due to the default file permissions configuration, which
conflicts with Snakemake's containerized conda environment activation mechanism.
Thus, running the containerized VIPERA workflow on the WSL is not advised.
Additionally, certain known issues arise when utilizing non-default temporary
directories. To address this issue, set the temporary directory to the default
before executing the workflow (e.g. `export TMPDIR=/tmp` in Linux machines).

0 comments on commit 75141e6

Please sign in to comment.