diff options
Diffstat (limited to 'doc/README.markdown')
| -rw-r--r-- | doc/README.markdown | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/README.markdown b/doc/README.markdown new file mode 100644 index 0000000..82004aa --- /dev/null +++ b/doc/README.markdown @@ -0,0 +1,47 @@ +# 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: + +[http://sourceforge.net/projects/quikr/](sourceforge project page) + +Our development GIT repository is available here: + +[http://rosalind.ece.drexel.edu/git/quikr/](rosalind.ece.drexel.edu/git/quikr/) + +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 |