Skip to content

Commit d14f2f4

Browse files
committed
Update SLURM profile and describe usage with newer Snakemake versions
1 parent 375890d commit d14f2f4

3 files changed

Lines changed: 22 additions & 4 deletions

File tree

config/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ This information may also be provided through the `--config` parameter.
6363
## Automated construction of a context dataset
6464

6565
Setting the `CONTEXT_FASTA` parameter to `null` (default) will enable
66-
the automatic download of sequences from the GISAID SARS-CoV-2 database.
66+
the automatic download of sequences from the GISAID EpiCoV SARS-CoV-2 database.
6767
An unset parameter has the same effect.
6868
To enable this, you must also [sign up to the GISAID platform](https://gisaid.org/register/)
6969
and provide your credentials by creating and filling an additional configuration
@@ -177,11 +177,16 @@ snakemake --use-conda -c4
177177
```
178178

179179
To run the analysis in an HPC environment using SLURM, we provide a
180-
[default profile configuration](/profile/default) as an example that
181-
should be modified to fit your needs. To use it, run the following command:
180+
default [SLURM profile configuration](/profile/slurm) as an example that
181+
should be modified to fit your needs. Read more about Snakemake profiles
182+
[here](https://snakemake.readthedocs.io/en/stable/executing/cli.html#executing-profiles).
183+
To use the profile, install the
184+
[Snakemake executor plugin for SLURM](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/slurm.html)
185+
and run one of the following commands:
182186

183187
```shell
184-
snakemake --use-conda --slurm --profile profile/default
188+
snakemake --slurm --profile profile/slurm # Snakemake v7
189+
snakemake --profile profile/slurm # Snakemake v8+
185190
```
186191

187192
Additionally, we offer the option of running the workflow within a containerized

profile/slurm/config.v8+.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
executor: slurm
2+
use-conda: true
3+
default-resources:
4+
- slurm_account="pgo"
5+
- slurm_partition="global"
6+
- mem="4000MB"
7+
- runtime="30m"
8+
- slurm_extra="--qos=short"
9+
jobs: 25
10+
shadow-prefix: "/scr/aherrera/"
11+
rerun-incomplete: True
12+
restart-times: 5
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
use-conda: true
12
default-resources:
23
- slurm_account="pgo"
34
- slurm_partition="global"

0 commit comments

Comments
 (0)