Functions extending the scons build tool for reproducible research in bioinformatics.
This package extends the scons build tool for the construction of reproducible workflows in bioinformatics.
This project is in fairly early stages of development, although I have been using scons to create workflows using an earlier version of this package for some time.
Why does SCons make sense for reproducible bioinformatics pipelines?
- SCons has a sophisticated mechanism for determining dependencies, meaning that re-running SCons will only re-execute steps needing updating
- Most of the work of pipelines is done by external programs, and SCons is explicitly designed to make it easy to run external programs
- On the other hand, SCons also allows the execution of arbitrary python code in creating your script, and thus one can leverage the power of the python standard library, Biopython, NumPy, etc in your script.
- Rather than dealing with a mess of filenames, subsequent steps in an SCons build are expressed in terms of file objects
- Steps in the pipeline are implemented using objects called “builders,” which implement a shell command or a python command in a in a way that consistently channels inputs into outputs
- Provides multiple mechanisms for cleanly executing isolated steps of the workflow
- SCons validates files and can fail incrementally
- Make is a classic and everywhere, but getting make to do complex things requires specialized (and often opaque) syntax
- ruffus is a lightweight way to automate bioinformatics pipelines. It also supports incremental recalculation. It does not, however, provide assistance for executing shell commands or managing files, and these must be done with explict sytem calls on “hand-built” strings.
- galaxy is a web-based tool for building remotely-executed workflows. This is a hugely attractive framework for exposing complex workflows using a graphical-interface, but occupies a very different niche from this project (which provides a command line interface to locally-executed programs).
Documentation is available on github: http://nhoffman.github.com/bioscons/
Make sure to update the __version__ variable in the bioscons/__init__.py file.
If you have not done so create a ~/.pypirc file:
python setup.py register
Proceed to build and upload:
python setup.py clean python setup.py sdist bdist_wheel twine upload dist/*
Development of this project begin using the 1.x version of scons, and seems to work so far using version 2.x. Future development will focus on version 2.x.
Obtain the source code from github. For read-only access:
git clone git://github.com/nhoffman/bioscons.git
git clone firstname.lastname@example.org:nhoffman/bioscons.git
cd bioscons python setup.py install
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|bioscons-0.7-py2-none-any.whl (24.7 kB) Copy SHA256 hash SHA256||Wheel||py2||Jun 10, 2014|
|bioscons-0.7.tar.gz (19.9 kB) Copy SHA256 hash SHA256||Source||None||Jun 10, 2014|