annotate README.rst @ 0:1d4dd6e51f8c draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
author iuc
date Fri, 20 Nov 2015 06:46:48 -0500
parents
children 7c21b4380e84
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
1 Trinity memory usage
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
2 ====================
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
3
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
4 As described on the official Trinity website
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
5 `FAQ <http://trinityrnaseq.sourceforge.net/trinity_faq.html#ques_comp_resources_required>`_,
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
6 trinity requires a large amount of memory to perform the assembly: "roughly
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
7 ~1G of RAM per 1M reads to be assembled"
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
8
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
9 By default, this tool is configured to limit the memory consumption to 30G.
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
10 You might need to lower this limit if the machine(s) executing the jobs have less memory available.
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
11 If you have a lot of reads to assemble and a machine with enough memory, you can increase it.
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
12 In both cases, you can edit the TRINITY_MEM_OPTIONS in the file:
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
13
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
14 <tool_dependency_dir>/environment_settings/TRINITY_MEM_OPTIONS/iuc/trinity/<hash_string>/env.sh
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
15
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
16 to lower the maximum memory usage to 2G for example:
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
17
1d4dd6e51f8c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/trinity commit 993ba7c18dcabb15aa76bca2fcc9211a5f58bf1d
iuc
parents:
diff changeset
18 TRINITY_MEM_OPTIONS='--max_memory 2G --bflyHeapSpaceMax 2G'