annotate README.rst @ 2:fba1f34838e6 draft

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