annotate dereplication/README.txt @ 0:88fc52f1c5db draft default tip

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