Skip to content

Commit f247867

Browse files
committed
docs: Add documentation
1 parent ce5fc82 commit f247867

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

docs/further.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Example setup
2+
3+
The cluster generic plugin enables access to workflow variables (such as `rule`, `resources`, or `threads`) within the strings used to define cluster generic plugin arguments.
4+
This makes it possible to create custom configurations for running workflows on various cluster systems that support a submission command accepting the path to a job script. The followig example Snakemake profile (see [Profiles](https://snakemake.readthedocs.io/en/stable/executing/cli.html#profiles)) shows this for a custom SLURM execution configuration setup. Submitting jobs with this setup would result in having the rule name of the current job contained in the SLURM job name.
5+
6+
```
7+
executor: cluster-generic
8+
cluster-generic-submit-cmd: sbatch --cpus-per-task {threads} --mem={resources.mem_mb} --job-name=smk-{rule} --parsable
9+
cluster-generic-cancel-cmd: scancel
10+
```
11+

docs/intro.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The cluster generic plugin allows submitting jobs to cluster systems that provide a submission command that accepts the path to a job script.
2+

0 commit comments

Comments
 (0)