annotate otu_clustering/README.txt @ 0:52043d3d71f5 draft

Uploaded
author qfab
date Wed, 28 May 2014 21:22:08 -0400
parents
children 5d05b34a5fdf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
1 Galaxy wrappers for USEARCH - UPARSE (OTU Clustering)
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
2 =====================================================
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
3
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
4 USEARCH requires a licence. Therefore an automated installation is not
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
5 possible at the moment.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
6
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
7 Requirements
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
8 =====================================================
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
9 Get your licenced USEARCH version 7, but not later then 7.0.1002 from here:
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
10 http://www.drive5.com/usearch/download.html
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
11
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
12
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
13 Manual Installation Steps
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
14 =====================================================
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
15 USEARCH is distributed as one file, known as the binary file or executable
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
16 file. It is completely self-contained: it does not require configuration
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
17 files, environment variables, third-party libraries or other external
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
18 dependencies. There is no setup script or installer because they're not
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
19 needed. To install it, all you do is download or copy the binary to a
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
20 directory that is accessible from the computer where you want to run the code.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
21
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
22 Step1:
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
23 Rename the binary file to usearch.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
24
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
25 Step2:
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
26 Move the binary file (usearch) to /usr/local/bin
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
27 Ensure /usr/local/bin is in your path. If needed add /usr/local/bin/ to your
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
28 path.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
29
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
30 Step3:
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
31 Ensure that you have read and execute permissions for the binary file.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
32 If needed, use the chmod command to set the execute bit, e.g.:
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
33 chmod +x /usr/local/bin/usearch
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
34
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
35
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
36 Further installation information and help can be found at:
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
37 http://drive5.com/usearch/manual/install.html
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
38
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
39
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
40 Disclaimer
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
41 =====================================================
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
42 This source code is provided by QFAB "as is", in the hope that it will be
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
43 useful, and any express or implied warranties, including, but not limited to,
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
44 the implied warranties of merchantability and fitness for a particular purpose
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
45 are disclaimed.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
46 IN NO EVENT SHALL QFAB BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
47 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES HOWEVER CAUSED AND ON ANY THEORY
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
48 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
49 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOURCE
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
50 CODE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
51
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
52 License
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
53 =====================================================
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
54 This work by QFAB Bioinformatics (as part of the GVL project http://genome.edu.au)
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
55 is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0
52043d3d71f5 Uploaded
qfab
parents:
diff changeset
56 International License.