X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=help%2Fhelp%2Fhtml%2Fmemory.html;h=4baebf2ce41a1981beea405667ac2018e57d5c22;hb=ee7fcf8d9d817e079c2f0498d149ec45a21f82dc;hp=396507b3ea07f2d2fc06a7409688b510437cea38;hpb=ab6545b7fa685f046bbb2ee5217a9e89700f3871;p=jalview.git diff --git a/help/help/html/memory.html b/help/help/html/memory.html index 396507b..4baebf2 100755 --- a/help/help/html/memory.html +++ b/help/help/html/memory.html @@ -28,24 +28,18 @@ Memory Usage Settings for Jalview +
When launched as an Application, Jalview will automatically + configure the amount of memory allocated to the program to be 90% of + physical memory. You may wish to change this behaviour - + particularly if you are working on a machine that runs other memory + intensive processes.
- When launched as an Application, Jalview automatically tries to
- maximise the amount of memory allocated to it (default settings are
- to try and use up to 90% of physical memory available to it).
- Sometimes it may require more memory, or if you are working in a
- shared memory environment you may want to limit the maximum amount
- of memory that it might use.
- This has to be set at the time Jalview is launched because of the way
- that Java runs on a computer - what is actually run is a program called
- a Java virtual machine (a JVM) which executes the java program instructions.
- The JVM has limits on the memory that can be allocated to the java program - and
- you might need to increase them if you are working with particularly
- large datasets.
If Jalview has not explicitly told you that
- it has run out of memory, then a common sign is that a function that
- normally works seems to have no effect when working with a larger
- set of sequences (this might include open dialog boxes for saving
- PNG files, or when interpreting the result of a web service
- calculation).
+ Signs that Jalview is Running out of Memory
If
+ Jalview has not explicitly told you that it has run out of memory,
+ then a common sign is that a function that normally works seems to
+ have no effect when working with a larger set of sequences (this
+ might include open dialog boxes for saving PNG files, or when
+ interpreting the result of a web service calculation).
Jalview Memory Usage Monitor: If you are concerned about @@ -58,108 +52,82 @@ window's background.
- Increasing the memory available to Jalview
- 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.
- This default setting can be altered in a number of different ways, depending on how you prefer to launch Jalview and how specific you want to be with the maximum memory setting.
+ Increasing the memory available to Jalview
The
+ amount of memory allocated is defined wheb Jalview is launched
+ because of the way that Java runs on a computer - what is actually
+ run is a program called a Java virtual machine (a JVM) which
+ executes the java program instructions. The JVM has limits on the
+ memory that can be allocated to the java program - and it is often
+ necessary to adjust them if you are working with particularly large
+ datasets, or need to make room for other processes on the machine.
+
Jalview 2.11 includes a launcher that automatically
+ configures the proportion of memory allocated to Jalview's JVM, and
+ its behaviour can be altered in a number of different ways:
- The easiest way to launch Jalview with a different percentage of physical memory available is to - create a text file with extension .jvl and with content that contains the line -
- jalview.jvmmempc=50 -- Replace the value with the percentage of memory you wish to allocate to Jalview. - -
- In Windows and in macOS you can then launch Jalview by double clicking on this file, and your memory setting will be used instead of the default value of 90. -
-- In Linux or other unix variants you can launch Jalview on the command line and provide your JVL file as an argument with -
- /PATH_TO_JALVIEW/Jalview /path/to/file/mymemorysetting.jvl -- - -
- If you want to use a memory setting like this and open a file you can use both the jvl and alignment files as command line arguments, but you must put the jvl file first, e.g. -
- /PATH_TO_JALVIEW/Jalview /path/to/file/mymemorysetting.jvl /path/to/alignments/myalignment.fa -- alternatively, you can use the standard Jalview command line arguments with or without the jvl file (first), e.g. -
- /PATH_TO_JALVIEW/Jalview /path/to/file/mymemorysetting.jvl -open http://www.jalview.org/examples/jpred_msa.fasta -annotations http://www.jalview.org/examples/jpred_msa.seq.concise -colour Clustal -- - -
- You can use command line arguments to control memory settings in Windows and macOS too:
-
- In Windows you must use, e.g.
-
- \PATH_TO_JALVIEW\Jalview.exe %HOMEPATH%\mymemorysetting.jvl -open %HOMEPATH%\myalignment.fa -- and in macOS you can use the macOS open command like this: -
- open /Applications/Jalview.app --args ~/mymemorysetting.jvl -open ~/myalignment.fa -- (put all the Jalview arguments after the --args parameter). - - -
- Launching Jalview directly with a JVM is entirely possible, but is not recommended as automatic updates and some other default settings will not operate. -
-
- However by launching Jalview in this way you have full access to the Java command line arguments.
- In particular you can set the maximum allowed memory with the -Xmx... JVM argument.
-
- -Xmx should be immediately followed (no space or equals) by the maximum amount of memory that you might want to launch Jalview with. This can be specified in bytes as just a number,
- or in kilobytes, megabytes or gigabytes by following the number with a "k", "m" or "g" respectively. e.g.
-
- -Xmx8g -- -
- Jalview binaries for Windows and macOS are distributed with their own JVM which you will find in +
+ jalview.jvmmempc=50In Windows and in macOS you can then launch Jalview by + double clicking on this file, and your memory setting will be used + instead of the default value.
+ /PATH_TO_JALVIEW/Jalview /path/to/file/mymemorysetting.jvlIf you want to use a memory setting like this and open a + file you can use both the jvl and alignment files as command line + arguments, but you must put the jvl file first, e.g.
+ /PATH_TO_JALVIEW/Jalview /path/to/file/mymemorysetting.jvl /path/to/alignments/myalignment.faAlternatively, you can use the standard Jalview command line + arguments with or without the jvl file (first), e.g.
+ /PATH_TO_JALVIEW/Jalview /path/to/file/mymemorysetting.jvl -open http://www.jalview.org/examples/jpred_msa.fasta -annotations http://www.jalview.org/examples/jpred_msa.seq.concise -colour ClustalYou can use command line arguments to control memory + settings in Windows and macOS too:
+ \PATH_TO_JALVIEW\Jalview.exe %HOMEPATH%\mymemorysetting.jvl -open %HOMEPATH%\myalignment.faIn macOS you can use the macOS open command like this:
+ open /Applications/Jalview.app --args ~/mymemorysetting.jvl -open ~/myalignment.fa(put all the Jalview arguments after the --args + parameter) +
+ -Xmx8gJalview binaries for Windows and macOS are distributed + with their own JVM which you will find in +
- You will also need to reference the "appdir" release folder with all of the Jalview jar files.
-
- On Windows this will be
-
\PATH_TO_JALVIEW\release- whereas on macOS it will be -
/Applications/Jalview.app/Contents/Resources/app/release- and on linux or unix -
/PATH_TO_JALVIEW/release- -
- Assuming the java (or java.exe on Windows) commands are available to you, you can run, e.g. -
+
\PATH_TO_JALVIEW\release+
/Applications/Jalview.app/Contents/Resources/app/release+ and on linux or unix
/PATH_TO_JALVIEW/release+
java -Xmx1500m -cp "/PATH_TO_RELEASE_DIR/*" jalview.bin.Jalview -- or on Windows -
+Or on Windows
java.exe -Xmx1500m -cp "\PATH_TO_RELEASE_DIR\*" jalview.bin.Jalview -- Note that the classpath argument wildcard must be simply a '*' and not '*.jar'. This is a limitation of Java. - -
- You can also add other Jalview command line arguments as above after the jalview.bin.Jalview class name (you cannot use jvl files if launching Jalview in this way).
-
-
-
+ Note: for this to work the classpath argument wildcard must be simply
+ a '*' and not '*.jar'.
+ You can also add other Jalview
+ command line arguments as above after the jalview.bin.Jalview
+ class name, but you cannot use jvl files
+ if launching Jalview in this way.
-