Skip to content

Commit

Permalink
Update memory info
Browse files Browse the repository at this point in the history
  • Loading branch information
petebankhead committed May 30, 2020
1 parent 6774372 commit 4ef48c9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
Binary file removed docs/intro/images/setup_memory.jpg
Binary file not shown.
Binary file added docs/intro/images/setup_memory.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 11 additions & 5 deletions docs/intro/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,23 @@ Setup options

When running QuPath for the first time, you will be prompted to specify some setup options.

.. figure:: images/setup_memory.jpg
.. figure:: images/setup_memory.png
:class: shadow-image
:width: 75%
:align: center

Setup options shown on startup.

The default is that QuPath will request 50% of the total memory available.
This is generally a reasonable choice, but be aware that the amount of memory available to QuPath is one of the main factors influencing how well the software will perform - and how complex the analysis can be.
This is generally a reasonable choice, but be aware that the amount of memory available to QuPath is one of the main factors influencing how well the software will perform -- and how complex the analysis can be.

.. warning::

Sometimes, your computer may block QuPath from overwriting the configuration file needed to set the maximum memory.
If this happens, you wil need to edit this file manually.

See :ref:`Set max memory` for instructions.


.. sidebar:: Why does the 'Region' matter?

Expand All @@ -54,8 +62,6 @@ This will help ensure behavior should match with what is shown in this documenta
Troubleshooting
===============

If QuPath installs but you can't set the memory limit, see :ref:`Set max memory`

If you have trouble installing at all, please see below...


Expand Down Expand Up @@ -147,7 +153,7 @@ One way to work around this is to remove the flag by opening `/Applications/Util
.. figure:: images/installing_macOS_damaged_terminal.png
:align: center
:width: 75%
:width: 90%



Expand Down

0 comments on commit 4ef48c9

Please sign in to comment.