Installation

bramble is available as a C++ executable or a Rust crate.

C++

bramble uses the meson build system. System dependencies are required for zlib, bz2, and lzma (meson will try to build zlib and bz2 via wrapdb if they aren't found on the system). You'll also need meson, ninja, and autotools installed.

Run build.sh directly, or build manually:

> meson setup build
> cd build
> ninja

This produces the bramble executable. Tested with meson 1.7 and 1.8 (likely works with older versions too).

Rust

> cargo install bramble-cli

This builds against the system htslib prerequisites (zlib, bzip2); a C compiler and libclang (for bindgen) are required at build time.

bramble-cli is the command-line front-end for bramble's Rust implementation. The projection logic lives in the I/O-free bramble-rs library; this crate adds the htslib-backed BAM reader/writer, threading, and CLI.

Note: the installed executable is named bramble-rs (the crate is bramble-cli only, to disambiguate it from the library on crates.io).

Next: Usage →