annotate README.rst @ 1:354e820eb485 draft

Docker support and update for protk 1.4
author iracooke
date Thu, 26 Mar 2015 21:27:53 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
1 Make Decoys
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
2 ===========
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
3
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
4 Create decoy sequences for tandem ms searching
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
5
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
6 Requirements
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
7 ------------
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
8
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
9 This package uses protk_ which needs to be present in order for the tool to work.
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
10
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
11 .. _protk: https://github.com/iracooke/protk
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
12
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
13 There are two ways you can satify this dependency (choose one):
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
14
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
15 1. **Manual Install:** Details on how to install protk_ manually are available here_.
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
16
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
17 2. **Use Docker:** This tool is 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.
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
18
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
19 .. _docker: https://www.docker.com/
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
20 .. _here: https://github.com/iracooke/protk/#galaxy-integration
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
21 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
22 __ container_
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
23
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
24
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
25 Further Info
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
26 ------------
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
27
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
28 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`__
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
29
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
30 .. _github: https://github.com/iracooke/protk-galaxytools
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
31 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
32 __ issue_
354e820eb485 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
33