JAL-3111 JAL-3348 removed pre 2.11 instructions on setting Jalview’s memory settings...
[jalview.git] / help / help / html / memory.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>Memory Settings</title>
24 </head>
25 <body>
26   <h2>
27     <center>
28       <strong>Memory Usage Settings for Jalview</strong>
29     </center>
30   </h2>
31   <p>
32     When launched as an Application, Jalview automatically tries to
33     maximise the amount of memory allocated to it, but sometimes it may
34     run out of memory. This is because of the way that Java runs on a
35     computer - what is actually run is a program called a virtual
36     machine (the JVM) which executes the java instructions. The JVM has
37     limits on the memory that can be allocated to the java program - and
38     you might need to increase them if you are working with particularly
39     large datasets.<br> If Jalview has not explicitly told you that
40     it has run out of memory, then a common sign is that a function that
41     normally works seems to have no effect when working with a larger
42     set of sequences (this might include open dialog boxes for saving
43     PNG files, or when interpreting the result of a web service
44     calculation).
45   </p>
46   <p>
47     <em>Jalview Memory Usage Monitor</em>: If you are concerned about
48     memory, or think that things might be behaving strangely because of
49     a shortage of memory, then you can check this by enabling the memory
50     usage monitor. This is done by selecting the <strong>Tools&#8594;Show
51       Memory Usage</strong> option. Once enabled, the memory usage monitor
52     displays the currently available memory, the total memory, and the
53     percentage free at the bottom left hand side of the Jalview Desktop
54     window's background.
55   </p>
56   <p>
57     <em>Increasing the memory available to Jalview</em><br>
58     Since Jalview 2.11, the program automatically configures the JVM memory settings to set the maximum memory available to Jalview to be 90% of physical memory. 
59       <p>&nbsp;</p>
60 </body>
61 </html>