INSTALL

   1 System Requirements
   2 ===================
   3
   4 SAMtools depends on the zlib library <http://www.zlib.net>. The latest
   5 version 1.2.3 is preferred and with the latest version you can compile
   6 razip and use it to compress a FASTA file. SAMtools' faidx is able to
   7 index a razip-compressed FASTA file to save diskspace. Older zlib also
   8 works with SAMtools, but razip cannot be compiled.
   9
  10 The text-based viewer (tview) requires the GNU ncurses library
  11 <http://www.gnu.org/software/ncurses/>, which comes with Mac OS X and
  12 most of the modern Linux/Unix distributions. If you do not have this
  13 library installed, you can still compile the rest of SAMtools by
  14 manually modifying one line in Makefile.
  15
  16 Pysam requires pyrex (0.9.8 or greater) and python (2.6 or greater).
  17 It has not been tested on many other platforms.
  18
  19 Compilation
  20 ===========
  21
  22 Unpack the distribution and enter the pysam directory. Type
  23
  24 python setup.py build
  25
  26 to compile.
  27
  28 Installation
  29 ============
  30
  31 Type
  32
  33    python setup.py install
  34
  35 to install it within the site-packages directory of your python
  36 distribution. Type
  37
  38    python setup.py install --help
  39
  40 for more options.
  41
  42 Architecture specific options
  43 =============================
  44
  45 Pysam has been compiled on various linux systems and works
  46 with python 2.6 and python 2.5.
  47
  48 Python 2.7 and Python 3 have not been tested.
  49
  50 Windows support does not work yet