annotate README.md @ 2:cf0d72c7b482 draft

Update.
author galaxyp
date Fri, 10 May 2013 17:31:05 -0400
parents ba86fd127f5a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
1 # OpenMS
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
2
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
3 If there is a tool that is part of OpenMS but not available here, let
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
4 John Chilton (jmchilton@gmail.com) and he will try to add it.
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
5
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
6 These tools require Galaxy to be equipped with common proteomic
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
7 datatypes. These can be obtained by installing Ira Cooke's ProtK via
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
8 the tool shed or merging the changesets from the following repository
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
9 into your Galaxy instance:
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
10
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
11 https://bitbucket.org/galaxyp/galaxy-dist-proteomics
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
12
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
13 # Installing
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
14
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
15 These tools all require OpenMS (at least version 1.10) and may require
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
16 other dependencies (such as PepNovo for instance).
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
17
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
18 For Galaxy-P we are installing this tool via CloudBioLinux
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
19 (https://github.com/jmchilton/cloudbiolinux/blob/proteomics/cloudbio/custom/bio_proteomics.py). While
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
20 this fabric script may not be exactly appropriate for your environment
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
21 it may serve as a template for how to install this software.
cf0d72c7b482 Update.
galaxyp
parents: 0
diff changeset
22
0
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
23 # Obtaining Tools
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
24
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
25 Repositories for all Galaxy-P tools can be found at
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
26 https:/bitbucket.org/galaxyp/.
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
27
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
28 # Contact
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
29
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
30 Please send suggestions for improvements and bug reports to
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
31 jmchilton@gmail.com.
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
32
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
33 # License
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
34
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
35 All Galaxy-P tools are licensed under the Apache License Version 2.0
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
36 unless otherwise documented.
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
37
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
38 # Tool Versioning
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
39
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
40 Galaxy-P tools will have versions of the form X.Y.Z. Versions
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
41 differing only after the second decimal should be completely
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
42 compatible with each other. Breaking changes should result in an
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
43 increment of the number before and/or after the first decimal. All
ba86fd127f5a Uploaded
galaxyp
parents:
diff changeset
44 tools of version less than 1.0.0 should be considered beta.