Mercurial > repos > iuc > sra_tools

annotate README.rst @ 17:c441583adae5 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit e00e33a3405201e8decbbb641ad0a8c3e16c8bef"
author iuc
date Wed, 29 Apr 2020 12:12:23 -0400
parents b723c120161a
children 7068f48d0ef9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
1 The Galaxy tool wrappers contained in this tool shed repository rely on software developed by
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
2 the NCBI: http://github.com/ncbi/sra-tools.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
3
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
4 NCBI Sequence Read Archive: http://www.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=software.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
5 Use of SRA Toolkit software herein should comply with the GPL v2 or greater.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
6
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
7 Copyright (C) 2013 Matthew Shirley
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
8
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
9 This program is free software: you can redistribute it and/or modify
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
10 it under the terms of the GNU General Public License as published by
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
11 the Free Software Foundation, either version 2 of the License, or
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
12 (at your option) any later version.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
13
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
14 This program is distributed in the hope that it will be useful,
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
17 GNU General Public License for more details.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
18
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
19 You should have received a copy of the GNU General Public License
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
21
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
22 # INSTALLATION
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
23
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
24 This software release was designed to install using the Galaxy toolshed under Linux and MacOS operating systems on Intel x86-compatible 32/64 bit architectures.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
25
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
26 *Build Requirements*
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
27
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
28 - bash
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
29 - make
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
30 - gcc
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
31 - g++
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
32 - libxml2
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
33
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
34 On a Debian OS use:
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
35
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
36 apt-get install build-essential libxml2-dev
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
37
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
38 On a Mac with [command line tools](https://developer.apple.com/downloads/index.action) installed:
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
39
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
40 brew install libxml2
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
41
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
42 # Installation of Aspera connect ascp binary
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
43
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
44 The sra-tools suite is ready to benefit from increased transfer speed and reliability by using Aspera Connect ascp.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
45 To benefit, download the ascp commandline client, and place ascp and the required ssh keys into a PATH accessible to galaxys job handler.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
46
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
47 A convenience package for linux and OS X is available at https://toolshed.g2.bx.psu.edu/view/mvdbeek/package_ascp_3/e109f0ec22c3 .
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
48 It suffices to copy the contents of the $INSTALL_DIR/bin into PATH.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
49
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
50 Alternatively go to http://downloads.asperasoft.com/connect2/ .
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
51
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
52 Aspera connect is not provided by the IUC due to its closed-source nature.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
53
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
54 # Firewall settings for highspeed transfer
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
55
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
56 To benefit from increased transfer speeds using ascp3 your local firewall must permit UDP data transfer in both
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
57 directions on ports 33001-33009 for the following IP ranges:
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
58
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
59 130.14.*.*
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
60
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
61 165.112.*.*
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
62
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
63 The firewall must also allow ssh traffic outbound to NCBI.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
64 The wrapper will fall back to http download if these requirements are not met.
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
65
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
66 CONTROLLED-ACCESS DATA
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
67
b723c120161a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/sra-tools commit d555f296be01d0c0fa5ac28d28a48cf4ada98297
iuc
parents:
diff changeset
68 Encrypted, controlled-access data is not supported.