Mercurial > repos > gga > tripal_phylogeny_sync

annotate README.rst @ 1:159fd092ca62 draft

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