| 1 |
System Requirements |
| 2 |
=================== |
| 3 |
|
| 4 |
SAMtools depends on the zlib library <http://www.zlib.net>. Version 1.2.3+ is |
| 5 |
preferred and with 1.2.3+ you can compile razip and use it to compress a FASTA |
| 6 |
file. SAMtools' faidx is able to index a razip-compressed FASTA file to save |
| 7 |
diskspace. Older zlib also works with SAMtools, but razip cannot be compiled. |
| 8 |
|
| 9 |
The text-based viewer (tview) requires the GNU ncurses library |
| 10 |
<http://www.gnu.org/software/ncurses/>, which comes with Mac OS X and most of |
| 11 |
the modern Linux/Unix distributions. If you do not have this library installed, |
| 12 |
you can still compile the rest of SAMtools by manually changing: |
| 13 |
`-D_CURSES_LIB=1' to `-D_CURSES_LIB=0' at the line starting with `DFLAGS=', and |
| 14 |
comment out the line starting with `LIBCURSES='. |
| 15 |
|
| 16 |
|
| 17 |
Compilation |
| 18 |
=========== |
| 19 |
|
| 20 |
Type `make' to compile samtools. If you have zlib >= 1.2.2.1, you can compile |
| 21 |
razip with `make razip'. |
| 22 |
|
| 23 |
|
| 24 |
Installation |
| 25 |
============ |
| 26 |
|
| 27 |
Copy `samtools', `bcftools/bcftools' and other executables/scripts in `misc' to |
| 28 |
a location you want (e.g. a directory in your $PATH). You may also copy |
| 29 |
`samtools.1' and `bcftools/bcftools.1' to a directory in your $MANPATH such |
| 30 |
that the `man' command may find the manual. |