Installation

Installation#

Install VAMPIRE using pip:

$ pip install vampire-tr
$ mamba install vampire-tr

Pull the prebuilt Singularity image:

$ singularity pull docker://zikunyang/vampire-tr:latest
$ singularity exec vampire-tr_latest.sif vampire --help

Build from definition file:

$ git clone https://github.com/Zikun-Yang/VAMPIRE.git
$ cd VAMPIRE
$ singularity build vampire-tr_latest.sif vampire.def
$ singularity exec vampire-tr_latest.sif vampire --help
$ docker pull zikunyang/vampire-tr:latest
$ docker run -it --name vampire-tr zikunyang/vampire-tr:latest
$ docker exec vampire-tr vampire --help

Requirements#

VAMPIRE requires Python 3.10+ to run. Core Python dependencies (including polars, numpy, plotly, anndata, biopython, numba, pysam, etc.) are installed automatically when you install the package via pip.

Verification#

After installation, verify that VAMPIRE is installed correctly:

$ vampire --help

You should see the VAMPIRE help message with available commands.