Recent changes to Installation

Installation modified by David Koslicki

David Koslicki — Wed, 15 May 2013 16:47:14 -0000

--- v3
+++ v4
@@ -1,16 +1,47 @@
-This is a quick example of how to get Quikr up and running as well as its basic usage.
+# How Can I Install The Quikr Utility? #
+To use Quikr there are several prerequisites.

-*To install*
-Either click the download link in the files tab, or else use git:
-#git clone git://git.code.sf.net/p/quikr/code quikr-code
-#cd quikr-code
-#matlab
-or
-#octave
-#xstar=quikr('testfastafile.fa');
-Then
-#length(find(xstar))
-should return 25.
+## Requirements ##
++ Mac OS X 10.6.8 or GNU/Linux
++ 4Gb of RAM minimum. Absolutely neccessary.
++ gcc that supports OpenMP

-Sometimes it is necessary (in linux) to 
-#chmod a+rx count-linux
+### 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

WikiPage Installation modified by David Koslicki

David Koslicki — Tue, 18 Dec 2012 21:47:30 -0000

--- v2
+++ v3
@@ -1,6 +1,7 @@
 This is a quick example of how to get Quikr up and running as well as its basic usage.

 *To install*
+Either click the download link in the files tab, or else use git:
 #git clone git://git.code.sf.net/p/quikr/code quikr-code
 #cd quikr-code
 #matlab

WikiPage Installation modified by David Koslicki

David Koslicki — Mon, 10 Dec 2012 19:04:35 -0000

--- v1
+++ v2
@@ -10,3 +10,6 @@
 Then
 #length(find(xstar))
 should return 25.
+
+Sometimes it is necessary (in linux) to 
+#chmod a+rx count-linux

WikiPage Example modified by David Koslicki

David Koslicki — Mon, 10 Dec 2012 19:03:23 -0000

This is a quick example of how to get Quikr up and running as well as its basic usage. *To install* #git clone git://git.code.sf.net/p/quikr/code quikr-code #cd quikr-code #matlab or #octave #xstar=quikr('testfastafile.fa'); Then #length(find(xstar)) should return 25.