-
Notifications
You must be signed in to change notification settings - Fork 44
Sunbeam extensions
Erik Clarke edited this page Feb 16, 2018
·
2 revisions
An extension should have the following directory structure (see sbx_example):
- a file named
{extension}.rulesthat will be directly "include"ed in the Sunbeam snakefile - (optionally) a file named
config.ymlthat will be added to the user's config file - (optionally) a file named
requirements.txtthat defines conda dependencies to install
Ideally, this should be as easy as simply cloning the repository to the sunbeam/extensions directory, and then appending the config file to your config file:
cat sunbeam/extensions/sbx_example/config.yml >> my_config.ymlIf necessary, install dependencies using conda:
conda install --file sunbeam/extensions/sbx_example/requirements.txtSimply remove the folder from the sunbeam/extensions directory.