annotate README.rst @ 0:d18ba611f741 draft

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