Skip to main content

A Structural Variant Post-Processing Package

Project description

http://mavis.bcgsc.ca/docs/latest/_static/acronym.svg

master branch build Status

(master)

develop branch build status

(develop)

About

MAVIS is python command-line tool for the post-processing of structural variant calls. The general MAVIS pipeline consists of six main stages

Getting Help

All steps in the MAVIS pipeline are called following the main mavis entry point. The usage menu can be viewed by running without any arguments, or by giving the -h/–help option

mavis -h

Help sub-menus can be found by giving the pipeline step followed by no arguments or the -h options

mavis cluster -h

Common problems and questions are addressed on the wiki. If you have a question or issue that is not answered there (or already a github issue) please submit a github issue to our github page or contact us by email at mavis@bcgsc.ca

Install Instructions

There are 3 major steps to setting up and installing MAVIS.

1. Install Aligner

In addition to the python package dependencies, MAVIS also requires an aligner to be installed. Currently the only aligners supported are blat and bwa mem. For MAVIS to run successfully the aligner must be installed and accessible on the path. If you have a non-standard install you may find it useful to edit the PATH environment variable. For example

export PATH=/path/to/directory/containing/blat/binary:$PATH

blat is the default aligner. To configure MAVIS to use bwa mem as a default instead, use the MAVIS environment variables. Make sure to specify BOTH of the variables below to change the default aligner.

export MAVIS_ALIGNER='bwa mem'
export MAVIS_ALIGNER_REFERENCE=/path/to/mem/fasta/ref/file

After these have been installed MAVIS itself can be installed through pip

2. Install MAVIS

The easiest way to install MAVIS is through the python package manager, pip. If you do not have python3 installed it can be found here

Ensuring you have a recent version of pip and setuptools will improve the install experience. Older versions of pip and setuptools may have issues with obtaining some of the mavis python dependencies

pip install --upgrade pip setuptools

or (for Anaconda users)

conda update pip setuptools

If this is not a clean/new python install it may be useful to set up mavis in a virtual python environment

Then install mavis itself

pip install mavis

This will install mavis and its python dependencies.

3. Build or Download Reference Files

After MAVIS is installed the reference files must be generated (or downloaded) before it can be run. A simple bash script to download the hg19 reference files and generate a MAVIS environment file is provided under mavis/tools for convenience.

cd /path/to/where/you/want/to/put/the/files
wget https://raw.githubusercontent.com/bcgsc/mavis/master/tools/get_hg19_reference_files.sh
bash get_hg19_reference_files.sh
source reference_inputs/hg19_env.sh

Once the above 3 steps are complete MAVIS is ready to be run. See the MAVIS tutorial to learn about running MAVIS.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mavis-1.8.5.tar.gz (8.9 MB view details)

Uploaded Source

Built Distribution

mavis-1.8.5-py3.6.egg (454.4 kB view details)

Uploaded Egg

File details

Details for the file mavis-1.8.5.tar.gz.

File metadata

  • Download URL: mavis-1.8.5.tar.gz
  • Upload date:
  • Size: 8.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mavis-1.8.5.tar.gz
Algorithm Hash digest
SHA256 3dd0d8fdbfccbfb2e446dda4a208840323c1e12495e67a8ff91f386b89116089
MD5 6581d841f461b14beb647b7fa7f7bab9
BLAKE2b-256 eb6ce3b19f9240547e9025fd43430852601351c2822330189b379cdb50e0e123

See more details on using hashes here.

File details

Details for the file mavis-1.8.5-py3.6.egg.

File metadata

  • Download URL: mavis-1.8.5-py3.6.egg
  • Upload date:
  • Size: 454.4 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mavis-1.8.5-py3.6.egg
Algorithm Hash digest
SHA256 cdbc3e78965e7edbe2ac803ca815f8af4e259f1c2bab32ab73fc52c66178a741
MD5 7e47ad8fc25be35bdb339aa54a736301
BLAKE2b-256 81967ce2364512969ed9db1d4ac25d211e053dcde6d0de863011937e245c3570

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page