client-memory.html

---
layout: default
title: Adjusting Client Memory Requirements
menu-id: l1-insight
pdfs:
    - client-memory.pdf
---
<p>By default, the OMERO clients allocate a certain amount of memory for
themselves during the start-up process which should be sufficient for most
uses. However, when dealing with very large images, you may encounter out
of memory exceptions while trying to import or display these large images. In
these situations, it is beneficial to increase the memory allocation to the
clients as outlined below.</p>

<div class="note">
<p class="note-title">Note</p>
<p class="note-text">Increasing the memory of your client applications depends on the operating
system and the client used. Also note that this guide does <span class="bold">not</span> cover
OMERO.web, which uses a different server-based configuration set-up.</p>
</div>

<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->
  
<div class="section" id="omero-importer-omero-insight-on-os-x">
  
<h2>OMERO.insight on OS X</h2>
    
<ul class="simple">
<li>Locate the <span class="bold">OMERO.insight.app</span> in Finder
and right click (or control+click) on it, choose <span class="bold">Show Package Contents</span> </li>
<li>Navigate to the <span class="bold">Contents</span> folder</li>
<li>Right-click on the <span class="bold">Info.plist</span> file, and select to open it in either
Xcode (if installed) or the Property List Editor</li>
<li>Within Xcode/Property List Editor, click and open the <span class="bold">Java</span> node.</li>
<li>Under <span class="bold">VMOptions</span>, you will see a line such as <span class="bold">-Xmx1024M</span>. This means you currently have 1024 Megabytes reserved
for the application to use. Increase this to something like <span class="bold">-Xmx2048M</span> if you wish to increase the allocated size to 2048
Megabytes</li>
</ul>
    
<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

<div class="figure align-center" id="memory-mac01"> <img alt="Opening the package contents on OS X" src="{{ site.baseurl }}/images/memory_mac01.png" style="width: 100%;" />

<p class="caption">Opening the package contents on OS X</p>
</div>

<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

<div class="figure align-center" id="memory-mac02"> <img alt="Opening the .plist file" src="{{ site.baseurl }}/images/memory_mac02.png" style="width: 100%;" />

<p class="caption">Opening the .plist file</p>
</div>
    
<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

<div class="figure align-center" id="memory-mac03"> <img alt="Client memory adjustment on OS X" src="{{ site.baseurl }}/images/memory_mac03.png" style="width: 100%;" />
    
<p class="caption">Client memory adjustment on OS X</p>
</div>

<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

</div><!-- End section -->
  
<div class="section" id="omero-importer-omero-insight-on-windows">
<h2>OMERO.insight on Windows</h2>
<p>To alter the memory allocation of the Windows clients, you must add an
optional parameter file to the same folder as the application.</p>
<p>For the <span class="bold">OMERO.insight.exe</span> application
this file should be named <span class="bold">OMERO.insight.vmoptions</span>.</p>
<p>The easiest way to get this file is to download <span class="bold">OMERO.insight.vmoptions</span> and copy it into the same directory as
your <span class="bold">OMERO.insight.exe</span> file.</p>
<p>The default file increases the memory allocation to 2048 Megabytes, however
you may if you choose, open the file in any text editor (such as <span class="bold">notepad.exe</span>) and change the value as described in<span class="bold"> OMERO.insight on OS X</span>.</p>
 
</div><!-- End section -->
  
<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->
  
<div class="section" id="omero-importer-omero-insight-on-unix-linux">
<h2>OMERO.insight on Unix/Linux</h2>
<p>Changing OMERO.insight memory allocation under
Unix requires you to edit the start-up script located with the clients, the <span class="bold">OMEROinsight_unix.sh</span> file.</p>
<p>For the OMERO.insight GUI, you will need to edit the <span class="bold">OMEROinsight_unix.sh</span> file
and change the <span class="code">java</span> <span class="code">-Xms256000000</span> <span class="code">-Xmx1024000000</span> <span class="code">-jar</span> <span class="code">omero.insight.jar</span> line with new minimum and preferred memory options (see
the <a class="reference external" href="http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/java.html">Java online documentation</a> for
a full description of these options).</p>
<div class="line-block">
<div class="line"><br /></div> <!-- end #line -->
</div> <!-- end #line-block -->

</div><!-- End section -->

<div class="page-end">
<p>All Tutorial Material is available on line at: <a href="http://help.openmicroscopy.org">www.help.openmicroscopy.org</a></p>
<p>The Main OME website is at: <a href="http://www.openmicroscopy.org">www.openmicroscopy.org</a></p>
</div> <!-- end page-end -->