Skip to content

Commit 4126ae5

Browse files
authored
Merge pull request #21 from harvardinformatics/docs
docs: paring the further docs to specific cannon info
2 parents 94872ab + 3579ca8 commit 4126ae5

File tree

3 files changed

+48
-559
lines changed

3 files changed

+48
-559
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This is a fork of the [SLURM executor plugin for Snakemake](https://github.com/snakemake/snakemake-executor-plugin-slurm) for the [Cannon cluster at Harvard University](https://docs.rc.fas.harvard.edu/kb/running-jobs/). It has all the same features as the SLURM plugin, but performs automatic partition selection for the Cannon cluster based on the resources specified in a given Snakemake rule. It also offers some error checking for partition selection.
44

5+
For full documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).
6+
57
## Installation
68

79
The executor can be installed [from PyPI](https://pypi.org/project/snakemake-executor-plugin-cannon/) with pip:
@@ -40,4 +42,4 @@ An example profile can be found at [`tests/cannon-test-profile/config.yaml`](htt
4042

4143
## Features
4244

43-
For documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).
45+
For full documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).

0 commit comments

Comments
 (0)