summaryrefslogtreecommitdiff
path: root/doc/install.markdown
blob: 5f27ce53771984f507df12e0d27809bb11943125 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# How Can I Install The Quikr Utility? #
To use Quikr there are several prerequisites. 

## Requirements ##
+ Mac OS X 10.6.8 or GNU/Linux
+ 4Gb of RAM minimum. Absolutely neccessary.
+ gcc that supports OpenMP

### Python Requirements ###
+ Python 2.7
+ Scipy 
+ Numpy
+ BioPython

### Mac Requirements ###
+ Mac OS X 10.6.8 (what we have tested)
+ GCC 4.7 or newer. (gcc 4.2 did not work, and is the default installation)
+ OCaml compiler mlton
+ OpenMP libraries (libgomp, usually comes with gcc)

### Linux Requirements ###
+ GCC 4.7 or newer
+ OCaml compiler mlton
+ OpenMP libraries (libgomp, usually comes with gcc)

We also have a Quikr implementation in Matlab so that you can easily integrate
Quikr into your custom programs and scripts.

## Installation ##
Our Quikr code is available on our sourceforge download page:

[sourceforge project page](http://sourceforge.net/projects/quikr/)

Alternatively you can clone the latest version from Github.

To install quikr, download our project and in the folder run:

    make
    sudo make install

This will install the quikr, quikr\_train and multifasta\_to\_otu utilities.
To install the python scripts and module systemwide, run

    make python
    sudo make install_python