# Snakemake executor plugin: cannon
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.
For full documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).
## Installation
The executor can be installed [from PyPI](https://pypi.org/project/snakemake-executor-plugin-cannon/) with pip:
```bash
pip install snakemake-executor-plugin-cannon
```
Or [from bioconda](https://bioconda.github.io/recipes/snakemake-executor-plugin-cannon/README.html) with conda/mamba:
```bash
mamba install snakemake-executor-plugin-cannon
```
## Specifying the executor
To use the executor with Snakemake, either specify it in the command line as:
```bash
snakemake -e cannon ...
```
Or add it to your [profile](https://github.com/harvardinformatics/snakemake-executor-plugin-cannon/blob/main/docs/profile.md):
```YAML
executor: cannon
```
## Setting up your profile
While this plugin does automatic partition selection, the user is still responsible for specifying other resources for rules in their workflow. This is usually done through a cluster **profile**, but this may differ based on your workflow.
See the [profile setup page](https://github.com/harvardinformatics/snakemake-executor-plugin-cannon/blob/main/docs/profile.md) for more information.
An example profile can be found at [`tests/cannon-test-profile/config.yaml`](https://github.com/harvardinformatics/snakemake-executor-plugin-cannon/blob/main/tests/cannon-test-profile/config.yaml)
## Features
For full documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "snakemake-executor-plugin-cannon",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "snakemake, plugin, executor, cluster, slurm, cannon, harvard",
"author": "Gregg Thomas",
"author_email": "gthomas@fas.harvard.edu",
"download_url": "https://files.pythonhosted.org/packages/99/b2/38cb51995161508e784a0c0e7674ae8327e2b77e28fc7b627b2a46edfeb1/snakemake_executor_plugin_cannon-1.6.0.post1.tar.gz",
"platform": null,
"description": "# Snakemake executor plugin: cannon \n\nThis 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.\n\nFor full documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).\n\n## Installation\n\nThe executor can be installed [from PyPI](https://pypi.org/project/snakemake-executor-plugin-cannon/) with pip:\n\n```bash\npip install snakemake-executor-plugin-cannon\n```\n\nOr [from bioconda](https://bioconda.github.io/recipes/snakemake-executor-plugin-cannon/README.html) with conda/mamba:\n\n```bash\nmamba install snakemake-executor-plugin-cannon\n```\n\n## Specifying the executor\n\nTo use the executor with Snakemake, either specify it in the command line as:\n\n```bash\nsnakemake -e cannon ...\n```\n\nOr add it to your [profile](https://github.com/harvardinformatics/snakemake-executor-plugin-cannon/blob/main/docs/profile.md):\n\n```YAML\nexecutor: cannon\n```\n\n## Setting up your profile\n\nWhile this plugin does automatic partition selection, the user is still responsible for specifying other resources for rules in their workflow. This is usually done through a cluster **profile**, but this may differ based on your workflow. \n\nSee the [profile setup page](https://github.com/harvardinformatics/snakemake-executor-plugin-cannon/blob/main/docs/profile.md) for more information. \n\nAn example profile can be found at [`tests/cannon-test-profile/config.yaml`](https://github.com/harvardinformatics/snakemake-executor-plugin-cannon/blob/main/tests/cannon-test-profile/config.yaml)\n\n## Features\n\nFor full documentation, see the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/cannon.html).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Snakemake executor plugin for submitting jobs to the Cannon cluster at Harvard University.",
"version": "1.6.0.post1",
"project_urls": {
"Documentation": "https://github.com/harvardinformatics/snakemake-executor-plugin-cannon",
"Repository": "https://github.com/harvardinformatics/snakemake-executor-plugin-cannon"
},
"split_keywords": [
"snakemake",
" plugin",
" executor",
" cluster",
" slurm",
" cannon",
" harvard"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5e64ac94a045c6d320a3c3b399fd4773a0966cabba49854ef7eb306de9bca98e",
"md5": "cd31dca9c5c6a67ac23512bdaf232289",
"sha256": "4d6746eb0b253336416814c9e039b09831150e76de8690c8c88111918e289280"
},
"downloads": -1,
"filename": "snakemake_executor_plugin_cannon-1.6.0.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd31dca9c5c6a67ac23512bdaf232289",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 21690,
"upload_time": "2025-07-25T18:36:37",
"upload_time_iso_8601": "2025-07-25T18:36:37.995577Z",
"url": "https://files.pythonhosted.org/packages/5e/64/ac94a045c6d320a3c3b399fd4773a0966cabba49854ef7eb306de9bca98e/snakemake_executor_plugin_cannon-1.6.0.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "99b238cb51995161508e784a0c0e7674ae8327e2b77e28fc7b627b2a46edfeb1",
"md5": "1b6bcc2c8b6b3be86974f396c4535821",
"sha256": "cec594ed6c49e388ac1c68cd6989da74171816833373a112a5034638ae7d0337"
},
"downloads": -1,
"filename": "snakemake_executor_plugin_cannon-1.6.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "1b6bcc2c8b6b3be86974f396c4535821",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 19599,
"upload_time": "2025-07-25T18:36:39",
"upload_time_iso_8601": "2025-07-25T18:36:39.006787Z",
"url": "https://files.pythonhosted.org/packages/99/b2/38cb51995161508e784a0c0e7674ae8327e2b77e28fc7b627b2a46edfeb1/snakemake_executor_plugin_cannon-1.6.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 18:36:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "harvardinformatics",
"github_project": "snakemake-executor-plugin-cannon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "snakemake-executor-plugin-cannon"
}
JSON
