annotate README.rst @ 4:6723249ce1bd draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
author iuc
date Thu, 14 Nov 2019 04:05:04 -0500
parents 64094e19077d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
1 Trinity memory usage
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
2 ====================
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
3
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
4 As described on the official Trinity website
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
5 `FAQ <http://trinityrnaseq.sourceforge.net/trinity_faq.html#ques_comp_resources_required>`_,
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
6 trinity requires a large amount of memory to perform the assembly: "roughly
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
7 ~1G of RAM per 1M reads to be assembled"
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
8
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
9 By default, this tool is configured to limit the memory consumption to 1G.
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
10 You might need to lower this limit if the machine(s) executing the jobs have less memory available.
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
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
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
12
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
13 This tool uses the GALAXY_MEMORY_MB environmental variable to limit the its memory usage. If you use a supported cluster type, you just need to limit the memory in the destination section of the job_conf.xml file to the amount of available memory (in MB), for example with a Slurm cluster::
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
14
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
15 <destination id="cluster_high_mem" runner="slurm
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
16 <param id="nativeSpecification">--mem=1024</param>
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
17 </destination>
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
18
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
19 If you cluster type does not support memory limit detection, you can also set manually the GALAXY_MEMORY_MB environmental variable in the destination section of the job_conf.xml file to the amount of available memory (in MB)::
0
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
20
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
21 <?xml version="1.0"?>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
22 <!-- A sample job config that explicitly configures job running the way it is configured by default (if there is no explicit config). -->
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
23 <job_conf>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
24 <plugins>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
25 <plugin id="local" type="runner" load="galaxy.jobs.runners.local:LocalJobRunner" workers="4"/>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
26 </plugins>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
27 <handlers>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
28 <handler id="main"/>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
29 </handlers>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
30 <destinations>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
31 <destination id="local" runner="local">
4
6723249ce1bd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit f3d9db3063d2cba26e6fbe82a3eee4e1a6fe0bd5"
iuc
parents: 0
diff changeset
32 <env id="GALAXY_MEMORY_MB">1024</env>
0
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
33 </destination>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
34 </destinations>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
35 </job_conf>
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
36
64094e19077d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 9dcdb5348f7439d0ce1e44ed23ad226beb4ae6d4
iuc
parents:
diff changeset
37