Mercurial > repos > gga > tripal_expression_sync_biomaterials

annotate README.rst @ 2:cc50b4a36f92 draft default tip

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 ea279e5b47cf3d5767328d17b0e40e57b0238ea1"
author gga
date Wed, 14 Aug 2019 10:05:24 -0400
parents 030d63ede604
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
030d63ede604 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
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
2 =============
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
3
030d63ede604 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
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
5
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
6 Dependencies
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
7 ------------
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
8
030d63ede604 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
030d63ede604 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:
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
11
030d63ede604 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
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
13
030d63ede604 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
030d63ede604 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
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
16 deactivate
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
17
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
18 Environment
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
19 -----------
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
20
030d63ede604 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:
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
22
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
23 +--------------------------------+-----------------------------------------------------------+
030d63ede604 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 |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
25 +================================+===========================================================+
030d63ede604 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 |
030d63ede604 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 |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
28 | | protocol. |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
29 +--------------------------------+-----------------------------------------------------------+
030d63ede604 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. |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
31 | | |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
32 +--------------------------------+-----------------------------------------------------------+
030d63ede604 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. |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
34 | | |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
35 | | |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
36 +--------------------------------+-----------------------------------------------------------+
030d63ede604 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 |
030d63ede604 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. |
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
39 +--------------------------------+-----------------------------------------------------------+
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
40
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
41
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
42 License
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
43 -------
030d63ede604 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/tripal commit 690532f4a8e36a334b2d4e15b832532fc1bb8d39
gga
parents:
diff changeset
44
030d63ede604 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.