annotate README.rst @ 4:acfc5e43fd5d draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
author iuc
date Fri, 15 Dec 2017 07:55:44 -0500
parents 1fb5ed80305f
children 24aa257e7241
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
1 Trinity memory usage
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
2 ====================
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
3
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
4 As described on the official Trinity website
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
5 `FAQ <http://trinityrnaseq.sourceforge.net/trinity_faq.html#ques_comp_resources_required>`_,
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
6 trinity requires a large amount of memory to perform the assembly: "roughly
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
7 ~1G of RAM per 1M reads to be assembled"
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
8
2
1fb5ed80305f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7efdf3224552d113a01043ee5bf4517d770df933
iuc
parents: 0
diff changeset
9 By default, this tool is configured to limit the memory consumption to 1G.
0
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
10 You might need to lower this limit if the machine(s) executing the jobs have less memory available.
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
11 If you have a lot of reads to assemble and a machine with enough memory, you can increase it.
4
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
12 In both cases, you can set the TRINITY_MAX_MEMORY environmental variable in the destination section of the job_conf.xml file::
0
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
13
4
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
14 <?xml version="1.0"?>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
15 <!-- A sample job config that explicitly configures job running the way it is configured by default (if there is no explicit config). -->
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
16 <job_conf>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
17 <plugins>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
18 <plugin id="local" type="runner" load="galaxy.jobs.runners.local:LocalJobRunner" workers="4"/>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
19 </plugins>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
20 <handlers>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
21 <handler id="main"/>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
22 </handlers>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
23 <destinations>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
24 <destination id="local" runner="local">
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
25 <env id="TRINITY_MAX_MEMORY">1G</env>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
26 </destination>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
27 </destinations>
acfc5e43fd5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7f726b691ead726864f1b67230cb5d58e16b5f58
iuc
parents: 2
diff changeset
28 </job_conf>
0
2edea1e4a5ec planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit b9a2194247d728ef4d5a3c5511aa6ea63e9b2bcb
iuc
parents:
diff changeset
29
2
1fb5ed80305f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 7efdf3224552d113a01043ee5bf4517d770df933
iuc
parents: 0
diff changeset
30