Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.63 KB

INSTALL.rst

File metadata and controls

64 lines (42 loc) · 1.63 KB

Installing Connor

Connor requires python 2.7 or later and has been tested with:

  • Python 2.7, 3.4 - 3.6
  • pysam 0.8.4 - 0.14.0
  • OSX and *nix RHEL6/7

Connor does not work in Windows OS because it depends on the python library pysam, which is not supported on Windows.

Connor runs in a single process and typical runs consume less than 2Gb mem.

Prerequisites

Note

Pip installs all required libraries; see [Installing] below.

  • cython
  • pysam
  • sortedcontainters

Installing

  • The simplest way to install Connor is through PyPI:

    $ pip install connor

  • You can also install Connor via the conda envirionment/package manager using the bioconda channel:

    $ conda install -c bioconda connor

  • If you don't have root permissions, you can install connor locally:

    $ pip install connor --user

    Following a --user install, you may need to adjust your path settings to include $HOME/.local/bin.

  • You can also install directly from source from github:

    $ pip install git+https://github.com/umich-brcf-bioinf/Connor

Uninstalling

$ pip uninstall connor

Advanced / Connor developers

If you already have prerequisite modules installed, you can also clone from github and run directly from the source like so:

$ git clone https://github.com/umich-brcf-bioinf/Connor

$ connor/connor-runner.py input.bam output.bam

For running automated tests, Connor also requires:
  • nosetests
  • testfixtures