annotate seal-galaxy-cc1b1911/README.md @ 0:244073d9abc1 draft default tip

Uploaded
author crs4
date Wed, 15 Oct 2014 09:41:10 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
244073d9abc1 Uploaded
crs4
parents:
diff changeset
1
244073d9abc1 Uploaded
crs4
parents:
diff changeset
2 Galaxy wrapper for the Seal toolkit
244073d9abc1 Uploaded
crs4
parents:
diff changeset
3 ====================================
244073d9abc1 Uploaded
crs4
parents:
diff changeset
4
244073d9abc1 Uploaded
crs4
parents:
diff changeset
5 These are the Galaxy wrappers for the Seal toolkit for Hadoop-based processing
244073d9abc1 Uploaded
crs4
parents:
diff changeset
6 of sequencing data (http://biodoop-seal.sf.net).
244073d9abc1 Uploaded
crs4
parents:
diff changeset
7
244073d9abc1 Uploaded
crs4
parents:
diff changeset
8
244073d9abc1 Uploaded
crs4
parents:
diff changeset
9 Installation
244073d9abc1 Uploaded
crs4
parents:
diff changeset
10 -------------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
11
244073d9abc1 Uploaded
crs4
parents:
diff changeset
12 You can install the Seal-Galaxy wrappers through the Galaxy toolshed or like
244073d9abc1 Uploaded
crs4
parents:
diff changeset
13 any other Galaxy tool. The installation process will try to fetch and build
244073d9abc1 Uploaded
crs4
parents:
diff changeset
14 Seal and some of its dependencies. However, you'll need to make sure that
244073d9abc1 Uploaded
crs4
parents:
diff changeset
15 the build process can find any required headers, libraries and executables,
244073d9abc1 Uploaded
crs4
parents:
diff changeset
16 such as:
244073d9abc1 Uploaded
crs4
parents:
diff changeset
17
244073d9abc1 Uploaded
crs4
parents:
diff changeset
18 * javac
244073d9abc1 Uploaded
crs4
parents:
diff changeset
19 * protobuf
244073d9abc1 Uploaded
crs4
parents:
diff changeset
20 * maven
244073d9abc1 Uploaded
crs4
parents:
diff changeset
21 * ant
244073d9abc1 Uploaded
crs4
parents:
diff changeset
22 * zlib
244073d9abc1 Uploaded
crs4
parents:
diff changeset
23 * git
244073d9abc1 Uploaded
crs4
parents:
diff changeset
24 * hadoop
244073d9abc1 Uploaded
crs4
parents:
diff changeset
25
244073d9abc1 Uploaded
crs4
parents:
diff changeset
26 For details on Seal's installation process refer directly to [its
244073d9abc1 Uploaded
crs4
parents:
diff changeset
27 documentation](http://biodoop-seal.sourceforge.net/installation.html).
244073d9abc1 Uploaded
crs4
parents:
diff changeset
28
244073d9abc1 Uploaded
crs4
parents:
diff changeset
29 Hadoop-Galaxy integration
244073d9abc1 Uploaded
crs4
parents:
diff changeset
30 ----------------------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
31
244073d9abc1 Uploaded
crs4
parents:
diff changeset
32 These wrappers use the [Hadoop-Galaxy](https://github.com/crs4/hadoop-galaxy)
244073d9abc1 Uploaded
crs4
parents:
diff changeset
33 tool to implement the integration between Hadoop and Galaxy. You should have a
244073d9abc1 Uploaded
crs4
parents:
diff changeset
34 look at its documentation.
244073d9abc1 Uploaded
crs4
parents:
diff changeset
35
244073d9abc1 Uploaded
crs4
parents:
diff changeset
36 An important issue
244073d9abc1 Uploaded
crs4
parents:
diff changeset
37 -----------------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
38
244073d9abc1 Uploaded
crs4
parents:
diff changeset
39 An implication of the integration provided by Hadoop-Galaxy is that Galaxy
244073d9abc1 Uploaded
crs4
parents:
diff changeset
40 knows nothing about your actual data. Because of this, removing the Galaxy
244073d9abc1 Uploaded
crs4
parents:
diff changeset
41 datasets does not delete the files produced by your Hadoop runs, potentially
244073d9abc1 Uploaded
crs4
parents:
diff changeset
42 resulting in the waste of a lot of space. Also, be careful with situations
244073d9abc1 Uploaded
crs4
parents:
diff changeset
43 where you may end up with multiple pathsets pointing to the same data, or where
244073d9abc1 Uploaded
crs4
parents:
diff changeset
44 they point to data that you want to access from Hadoop but would not want to
244073d9abc1 Uploaded
crs4
parents:
diff changeset
45 delete (e.g., your run directories).
244073d9abc1 Uploaded
crs4
parents:
diff changeset
46
244073d9abc1 Uploaded
crs4
parents:
diff changeset
47 Have a look at the Hadoop-Galaxy README for more details.
244073d9abc1 Uploaded
crs4
parents:
diff changeset
48
244073d9abc1 Uploaded
crs4
parents:
diff changeset
49
244073d9abc1 Uploaded
crs4
parents:
diff changeset
50 Authors
244073d9abc1 Uploaded
crs4
parents:
diff changeset
51 -------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
52
244073d9abc1 Uploaded
crs4
parents:
diff changeset
53 Luca Pireddu <pireddu@crs4.it>
244073d9abc1 Uploaded
crs4
parents:
diff changeset
54
244073d9abc1 Uploaded
crs4
parents:
diff changeset
55
244073d9abc1 Uploaded
crs4
parents:
diff changeset
56 Support
244073d9abc1 Uploaded
crs4
parents:
diff changeset
57 -------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
58
244073d9abc1 Uploaded
crs4
parents:
diff changeset
59 No support is provided.
244073d9abc1 Uploaded
crs4
parents:
diff changeset
60
244073d9abc1 Uploaded
crs4
parents:
diff changeset
61
244073d9abc1 Uploaded
crs4
parents:
diff changeset
62
244073d9abc1 Uploaded
crs4
parents:
diff changeset
63 License
244073d9abc1 Uploaded
crs4
parents:
diff changeset
64 --------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
65
244073d9abc1 Uploaded
crs4
parents:
diff changeset
66 This code is release under the GPLv3.
244073d9abc1 Uploaded
crs4
parents:
diff changeset
67
244073d9abc1 Uploaded
crs4
parents:
diff changeset
68
244073d9abc1 Uploaded
crs4
parents:
diff changeset
69
244073d9abc1 Uploaded
crs4
parents:
diff changeset
70 Copyright
244073d9abc1 Uploaded
crs4
parents:
diff changeset
71 --------------
244073d9abc1 Uploaded
crs4
parents:
diff changeset
72
244073d9abc1 Uploaded
crs4
parents:
diff changeset
73 Copyright CRS4, 2011-2014.