Name: biokepi
Owner: Hammer Lab
Description: Bioinformatics Ketrew Pipelines
Created: 2014-12-16 19:19:07.0
Updated: 2017-05-31 19:03:01.0
Pushed: 2017-11-14 13:27:35.0
Homepage: null
Size: 1966
Language: OCaml
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This project provides a family of libraries to construct ?Ketrew Workflows? for bioinformatics pipelines.
This should be considered ?alpha / preview? software.
See the documentation at
www.hammerlab.org/docs/biokepi/master
.
The main dependency is Ketrew (which requires OCaml ? 4.02.2).
To install the pre-release through opam
:
opam pin add biokepi "https://github.com/hammerlab/biokepi.git#biokepi.0.0.0"
[opam install biokepi]
To use the master
branch you need also to track the master
branch of Ketrew:
opam pin add ketrew https://github.com/hammerlab/ketrew.git
opam pin add biokepi https://github.com/hammerlab/biokepi.git
To build locally:
make
make clean ; WITH_TESTS=true make # To build also all the tests
make doc # To build the documentation, then cf. _build/doc/index.html
The Biokepi
module is the main entry point for most use cases.
There are ?demo? command-line applications in the src/app/
directory and
tests in src/test/
.
The main demo application (src/app/main.ml
) is documented here: Use the demo.