annotate README.rst @ 1:73d61745dcf2 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:25:47 -0400
parents
children 8fea07ae5d94
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
73d61745dcf2 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
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
2 =============
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
3
73d61745dcf2 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
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
5
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
6 Dependencies
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
7 ------------
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
8
73d61745dcf2 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
73d61745dcf2 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:
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
11
73d61745dcf2 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
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
13
73d61745dcf2 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
73d61745dcf2 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
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
16 deactivate
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
17
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
18 Environment
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
19 -----------
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
20
73d61745dcf2 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:
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
22
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
23 +--------------------------------+-----------------------------------------------------------+
73d61745dcf2 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 |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
25 +================================+===========================================================+
73d61745dcf2 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 |
73d61745dcf2 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 |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
28 | | protocol. |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
29 +--------------------------------+-----------------------------------------------------------+
73d61745dcf2 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. |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
31 | | |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
32 +--------------------------------+-----------------------------------------------------------+
73d61745dcf2 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. |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
34 | | |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
35 | | |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
36 +--------------------------------+-----------------------------------------------------------+
73d61745dcf2 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 |
73d61745dcf2 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. |
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
39 +--------------------------------+-----------------------------------------------------------+
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
40
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
41
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
42 License
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
43 -------
73d61745dcf2 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
44
73d61745dcf2 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
73d61745dcf2 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.