annotate README.rst @ 1:6c15d4e96b84 draft

planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
author gga
date Tue, 19 Sep 2017 12:26:10 -0400
parents
children 52f0e9417dc1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
1 Galaxy-tripal
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
2 =============
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
3
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
4 Galaxy tools to interface with Tripal using pyhon-tripal
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
5
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
6 Dependencies
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
7 ------------
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
8
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
9 You will need to install some python modules in the Galaxy virtualenv for these
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
10 tools to be fully functional:
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
11
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
12 .. code:: bash
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
13
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
14 . /path/to/galaxy/.venv/bin/activate
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
15 pip install future tripal
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
16 deactivate
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
17
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
18 Environment
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
19 -----------
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
20
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
21 The following environment variables must be set:
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
22
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
23 +--------------------------------+-----------------------------------------------------------+
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
24 | ENV | Use |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
25 +================================+===========================================================+
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
26 | ``$GALAXY_TRIPAL_URL`` | The URL at which Tripal is accessible, internal to Galaxy |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
27 | | and where the tools run. Must be absolute, with FQDN and |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
28 | | protocol. |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
29 +--------------------------------+-----------------------------------------------------------+
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
30 | ``$GALAXY_TRIPAL_USER`` | The admin user which Galaxy should use to talk to Tripal. |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
31 | | |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
32 +--------------------------------+-----------------------------------------------------------+
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
33 | ``$GALAXY_TRIPAL_PASSWORD`` | The password for the admin user. |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
34 | | |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
35 | | |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
36 +--------------------------------+-----------------------------------------------------------+
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
37 | ``$GALAXY_TRIPAL_SHARED_DIR`` | Directory shared between Galaxy and Tripal, used to |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
38 | | exchange data files. |
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
39 +--------------------------------+-----------------------------------------------------------+
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
40
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
41
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
42 License
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
43 -------
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
44
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
45 All python scripts, wrappers, and the webapollo.py are licensed under
6c15d4e96b84 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
46 MIT license.