Mercurial > repos > gga > apollo_create_account

annotate README.rst @ 6:2fb1e4193edd 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/apollo commit d9f27b297d9a919471c92b02ecf6cc9554457211
author gga
date Tue, 30 Oct 2018 04:32:30 -0400
parents 08f8e19005a8
children a46a509386d3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
1 Galaxy-apollo
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
2 =============
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
3
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
4 Galaxy tools to interface with Apollo The webapollo.py file is also
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
5 `separately
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
6 available <https://github.com/galaxy-genome-annotation/python-apollo>`__
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
7 as a pip-installable package.
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
8
1
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
9 Dependencies
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
10 ------------
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
11
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
12 You will need to install some python modules in the Galaxy virtualenv for these
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
13 tools to be fully functional:
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
14
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
15 .. code:: bash
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
16
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
17 . /path/to/galaxy/.venv/bin/activate
4
08f8e19005a8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit 70fbb41d4c6b0a08a7bed4849a5ae7c865e1ab1e
gga
parents: 1
diff changeset
18 pip install six biopython bcbio-gff
1
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
19 deactivate
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
20
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
21 Environment
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
22 -----------
0
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
23
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
24 The following environment variables must be set:
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
25
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
26 +--------------------------------+-----------------------------------------------------------+
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
27 | ENV | Use |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
28 +================================+===========================================================+
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
29 | ``$GALAXY_WEBAPOLLO_URL`` | The URL at which Apollo is accessible, internal to Galaxy |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
30 | | and where the tools run. Must be absolute, with FQDN and |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
31 | | protocol. |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
32 +--------------------------------+-----------------------------------------------------------+
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
33 | ``$GALAXY_WEBAPOLLO_USER`` | The admin user which Galaxy should use to talk to Apollo. |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
34 | | |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
35 +--------------------------------+-----------------------------------------------------------+
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
36 | ``$GALAXY_WEBAPOLLO_PASSWORD`` | The password for the admin user. |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
37 | | |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
38 | | |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
39 +--------------------------------+-----------------------------------------------------------+
1
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
40 | ``$GALAXY_WEBAPOLLO_EXT_URL`` | May be relative or absolute. |
0
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
41 | | The external URL at which Apollo is accessible to end |
1
509a0c4a94e8 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents: 0
diff changeset
42 | | users. |
0
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
43 +--------------------------------+-----------------------------------------------------------+
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
44 | ``$GALAXY_SHARED_DIR`` | Directory shared between Galaxy and Apollo, used to |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
45 | | exchange JBrowse instances. |
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
46 +--------------------------------+-----------------------------------------------------------+
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
47
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
48 License
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
49 -------
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
50
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
51 All python scripts, wrappers, and the webapollo.py are licensed under
f889e757ca93 planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff changeset
52 MIT license.