comparison README.rst @ 15:6c751c59ce18 draft

Docker support and update for protk 1.4
author iracooke
date Thu, 26 Mar 2015 20:04:30 -0400
parents
children
comparison
equal deleted inserted replaced
14:32365fec702c 15:6c751c59ce18
1 MS-GF+
2 ======
3
4 Galaxy wrapper for the `MS-GF+`__ tandem ms search tool
5
6 .. _msgfplus: http://proteomics.ucsd.edu/software-tools/ms-gf/
7 __ msgfplus_
8
9 Requirements
10 ------------
11
12 This package uses protk_, msgfplus_ and the `idconvert` tool from Proteowizard_ which need to be present in order for the tool to work.
13
14 .. _protk: https://github.com/iracooke/protk
15 .. _Proteowizard: http://proteowizard.sourceforge.net/
16
17
18 There are two ways you can satify these dependencies (choose one):
19
20 1. **Manual Install:** Details on how to install protk_, msgfplus_ and Proteowizard_ manually are available here_.
21
22 2. **Use Docker:** These tools are designed to run inside a docker_ container. If your galaxy supports `running tools within a docker container`__ you don't need to worry about dependencies. Simply install and things should just work. The docker container itself is versioned and new versions of this tool will automatically download an update to the container if needed.
23
24 .. _docker: https://www.docker.com/
25 .. _here: https://github.com/iracooke/protk/#galaxy-integration
26 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
27 __ container_
28
29
30 Further Info
31 ------------
32
33 The source code for this tool and other protk galaxy tools is on github_. Please visit the github page to contribute to the project or to `report an issue`__
34
35 .. _github: https://github.com/iracooke/protk-galaxytools
36 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
37 __ issue_
38
39
40 Information on the MS-GF+ search tool itself can be found here_
41
42 .. _here: http://proteowizard.sourceforge.net/
43