Raptor
A fast and space-efficient pre-filter
index

Setup

Download and Installation

There may be performance benefits when compiling from source as the build can be optimized for the host system.

Install with conda and bioconda (Linux)

conda install -c bioconda -c conda-forge raptor

Compile from source

Prerequisites

  • CMake >= 3.21
  • GCC 11, 12 or 13 (most recent minor version)
  • git

Refer to the Seqan3 Setup Tutorial for more in depth information.

Download current main branch

git clone https://github.com/seqan/raptor
cd raptor
git submodule update --init

Download specific version

E.g., for version 1.1.0:

git clone --branch raptor-v1.1.0 --recurse-submodules https://github.com/seqan/raptor

Or from within an existing repository

git checkout raptor-v1.1.0

Building

cd raptor
mkdir -p build
cd build
cmake ..
make

The binary can be found in bin.

You may want to add the Raptor executable to your PATH:

export PATH=$(pwd)/bin:$PATH
raptor --version

By default, Raptor will be built with host specific optimizations (-march=native). This behavior can be disabled by passing -DHIBF_NATIVE_BUILD=OFF to CMake.