annotate README.txt @ 2:386bf3c10c46 draft default tip

Uploaded
author ketan
date Tue, 15 Oct 2013 16:22:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
1 A simple Hello World Swift tool to run with Galaxy.
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
2
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
3 To set up with your Galaxy environment follow the steps below:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
4 0. Prerequisite: Sun/Oracle java. Should work with IBM java but not tested rigorously.
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
5
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
6 1. Download and install Swift where Galaxy server is running. From a command prompt the following wget will pull the latest release:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
7
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
8 wget http://www.ci.uchicago.edu/swift/packages/swift-0.94.1.tar.gz
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
9
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
10 Do untar at a suitable location:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
11
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
12 tar zxf swift-0.94.1.tar.gz
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
13
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
14 Put the bin dir on system PATH:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
15
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
16 export PATH=$PATH:/location/to/swift-0.94.1/bin
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
17
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
18 Edit above line to match the location of Swift and add it to your environment file (.bashrc, .bash_profile or the corresponding ones for other shells).
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
19
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
20 Make sure Swift is available from a command prompt:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
21
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
22 which swift
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
23 swift -version
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
24
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
25 2. untar and copy the swift-galaxy.tgz to the tools directory of your Galaxy location:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
26
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
27 tar zxf swift-galaxy.tgz
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
28
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
29 cp -r swift-galaxy /location/of/galaxy-server/tools/
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
30
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
31 3. Edit the tool_conf.xml file present at the top-level of galaxy-server directory tree to add the following lines between the <toolbox> and </toolbox> xml tags:
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
32
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
33 <section name="swift-hello" id="swift-hello">
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
34 <tool file="swift-galaxy/helloswift.xml" />
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
35 </section>
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
36
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
37 4. Restart the Galaxy server. The swift-galaxy tool should be available in the tool box of Galaxy GUI.
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
38
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
39 5. Invoke it by entering any number in the dialog box or leaving it to default. A message "Hello World!" will be written to output files as many times and the files should be available for browsing from Galaxy GUI.
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
40
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
41 Please note that the Cluster option is not implemented in this example.
386bf3c10c46 Uploaded
ketan
parents:
diff changeset
42