Skip to content

Commit

Permalink
Add instructions to avoid using the home directory on Dardel for appt…
Browse files Browse the repository at this point in the history
…ainer and conda
  • Loading branch information
verku committed Nov 15, 2024
1 parent 26d968a commit 5259aab
Showing 1 changed file with 17 additions and 20 deletions.
37 changes: 17 additions & 20 deletions config/slurm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ module load PDC bioinfo-tools conda apptainer tmux
but the equivalent tool `screen` is pre-installed and does
not need to be loaded.

> Apptainer (former singularity) will store its cache per
default in your home directory which will quickly run out of
storage space. You can tell it to use your `scratch` instead, a
temporary directory with unlimited space by adding this row
to your `~/.bashrc`: `export APPTAINER_CACHEDIR=$PDC_TMP`.

2) After cloning the repository, change permissions for the
Snakefile:

Expand All @@ -19,21 +25,19 @@ chmod 755 Snakefile

3) Create the GenErode conda environment or update an earlier
version. The latest conda environment contains the Snakemake
executor plugin for slurm:

```
conda env create -f environment.yml -n generode
```

- If you want to create a conda environment in a different location
than your home directory, you can provide a path to a directory
for the conda environment to be installed in, and run the following
command instead of the command above:
executor plugin for slurm. Since home directories on Dardel
are limited in storage space, you need to create a directory in
your storage project for the conda environment to be installed
in, and run the following command instead of the command above:

```
conda env create -f environment.yml -p /cfs/klemming/projects/supr/sllstore.../generode
```

> Note that you can save storage space in your storage project
on Dardel by creating a common GenErode conda environment for
several people.

4) Copy the configuration file `config/slurm/profile/config_plugin_dardel.yaml`
to `slurm/config.yaml`. This file specifies Snakemake and apptainer
parameters that are used to run the pipeline, as well as compute
Expand All @@ -60,16 +64,9 @@ resources specified under`default-resources`.

- Open a tmux session (alternatively, you can use screen)

- Activate the GenErode conda environment (created or updated
from `environment.yml`):

```
conda activate generode
```

If you have created the conda environment in a different directory
than your home directory, run the following commands, replacing the
path to the location of the conda environment accordingly:
- Activate the GenErode conda environment with the
following commands, replacing the path to the location of
the conda environment accordingly:

```
export CONDA_ENVS_PATH=/cfs/klemming/home/.../
Expand Down

0 comments on commit 5259aab

Please sign in to comment.