Mercurial > repos > gga > apollo_create_or_update
annotate README.rst @ 4:aee984715db1 draft
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit 70fbb41d4c6b0a08a7bed4849a5ae7c865e1ab1e
author | gga |
---|---|
date | Mon, 12 Mar 2018 06:32:08 -0400 |
parents | b194ffbd6ae1 |
children | d72192ec8e39 |
rev | line source |
---|---|
0
cd595b5d890a
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 |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
2 ============= |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
3 |
cd595b5d890a
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 |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
5 `separately |
cd595b5d890a
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>`__ |
cd595b5d890a
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. |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
8 |
1
b194ffbd6ae1
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 |
b194ffbd6ae1
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
0
diff
changeset
|
10 ------------ |
b194ffbd6ae1
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
0
diff
changeset
|
11 |
b194ffbd6ae1
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 |
b194ffbd6ae1
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: |
b194ffbd6ae1
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
0
diff
changeset
|
14 |
b194ffbd6ae1
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 |
b194ffbd6ae1
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
0
diff
changeset
|
16 |
b194ffbd6ae1
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
aee984715db1
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
b194ffbd6ae1
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 |
b194ffbd6ae1
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f55bad7dcf56bd9625874cd89f3894aee35d91ef
gga
parents:
0
diff
changeset
|
20 |
b194ffbd6ae1
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 |
b194ffbd6ae1
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
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
23 |
cd595b5d890a
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: |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
25 |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
26 +--------------------------------+-----------------------------------------------------------+ |
cd595b5d890a
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 | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
28 +================================+===========================================================+ |
cd595b5d890a
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 | |
cd595b5d890a
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 | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
31 | | protocol. | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
32 +--------------------------------+-----------------------------------------------------------+ |
cd595b5d890a
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. | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
34 | | | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
35 +--------------------------------+-----------------------------------------------------------+ |
cd595b5d890a
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. | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
37 | | | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
38 | | | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
39 +--------------------------------+-----------------------------------------------------------+ |
1
b194ffbd6ae1
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
cd595b5d890a
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
b194ffbd6ae1
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
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
43 +--------------------------------+-----------------------------------------------------------+ |
cd595b5d890a
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 | |
cd595b5d890a
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. | |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
46 +--------------------------------+-----------------------------------------------------------+ |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
47 |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
48 License |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
49 ------- |
cd595b5d890a
planemo upload for repository https://github.com/galaxy-genome-annotation/galaxy-tools/tree/master/tools/apollo commit f745b23c84a615bf434d717c8c0e553a012f0268
gga
parents:
diff
changeset
|
50 |
cd595b5d890a
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 |
cd595b5d890a
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. |