annotate README.rst @ 3:13ce6841218c draft

planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit d21999bb3e142fd972a3338b70216989a257d5b1
author gga
date Mon, 06 Aug 2018 04:45:08 -0400
parents 49d35a38bd85
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
8c9e0534386d 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
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
2 =============
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
3
2
49d35a38bd85 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 81a83f06b49db32928ba0cd44e5b6d0431868d27
gga
parents: 1
diff changeset
4 Galaxy tools to interface with Tripal using python-tripal
1
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
5
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
6 Dependencies
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
7 ------------
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
8
8c9e0534386d 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
8c9e0534386d 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:
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
11
8c9e0534386d 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
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
13
8c9e0534386d 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
8c9e0534386d 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
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
16 deactivate
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
17
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
18 Environment
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
19 -----------
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
20
8c9e0534386d 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:
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
22
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
23 +--------------------------------+-----------------------------------------------------------+
8c9e0534386d 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 |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
25 +================================+===========================================================+
8c9e0534386d 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 |
8c9e0534386d 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 |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
28 | | protocol. |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
29 +--------------------------------+-----------------------------------------------------------+
8c9e0534386d 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. |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
31 | | |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
32 +--------------------------------+-----------------------------------------------------------+
8c9e0534386d 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. |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
34 | | |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
35 | | |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
36 +--------------------------------+-----------------------------------------------------------+
8c9e0534386d 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 |
8c9e0534386d 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. |
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
39 +--------------------------------+-----------------------------------------------------------+
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
40
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
41
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
42 License
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
43 -------
8c9e0534386d planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
diff changeset
44
2
49d35a38bd85 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 81a83f06b49db32928ba0cd44e5b6d0431868d27
gga
parents: 1
diff changeset
45 All python scripts and wrappers are licensed under MIT license.