annotate README.rst @ 1:446eee605ac1 draft

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