Sunbeam extensions

Structure

An extension should have the following directory structure (see sbx_example):

• a file named {extension}.rules that will be directly "include"ed in the Sunbeam snakefile
• (optionally) a file named config.yml that will be added to the user's config file
• (optionally) a file named requirements.txt that defines conda dependencies to install

Installation

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.yml

If necessary, install dependencies using conda:

conda install --file sunbeam/extensions/sbx_example/requirements.txt

Uninstallation

Simply remove the folder from the sunbeam/extensions directory.