comparison README.rst @ 14:d90c8bc10a9c draft

Docker support and update for protk 1.4
author iracooke
date Thu, 26 Mar 2015 19:55:19 -0400
parents
children
comparison
equal deleted inserted replaced
13:b793fe628648 14:d90c8bc10a9c
1 TPP Prophets
2 ============
3
4 Galaxy wrappers for Peptide Prophet, iProphet and Protein Prophet
5
6 Requirements
7 ------------
8
9 This package uses protk_ and the trans_proteomic_pipeline_ which need to be present in order for the tool to work.
10
11 .. _protk: https://github.com/iracooke/protk
12 .. _trans_proteomic_pipeline: http://tools.proteomecenter.org/wiki/index.php?title=Software:TPP
13
14 There are two ways you can satify these dependencies (choose one):
15
16 1. **Manual Install:** Details on how to install protk_ and the trans_proteomic_pipeline_ manually are available here_.
17
18 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.
19
20 .. _docker: https://www.docker.com/
21 .. _here: https://github.com/iracooke/protk/#galaxy-integration
22 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
23 __ container_
24
25
26 Further Info
27 ------------
28
29 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`__
30
31 .. _github: https://github.com/iracooke/protk-galaxytools
32 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
33 __ issue_
34
35 Please visit the TPP__ website for details of the various Prophet tools
36
37 __ trans_proteomic_pipeline_