Installation

Operating systems

ISET3D-v4 has been tested on Ubuntu/Linux, MacOS, and Windows 10 and 11.

Required

To run ISET3d-v4 locally the user needs three things.

1. MATLAB, along with the image processing, signal processing, and parallel computing toolboxes.

2. Docker (typically pre-installed on Mac & Linux, but needs to be downloaded on Windows).

3. The PBRT Docker image. It should be pulled automatically when needed, but just in case you can get also get it manually using:

             `docker pull camerasimulation/pbrt-v4-cpu`
   

4. If you plan to run remotely, or with a GPU, see the ISET3d-V4 remote setup instructions

ISETCam or ISETBio

We use ISET3d with ISETCam (for engineers working with cameras) or ISETBio (for scientists and engineers working with human vision).

ISETCam can be downloaded using: git clone http://github.com/ISET/isetcam.git

ISETBio can be downloaded using: git clone https://github.com/isetbio/isetbio.git

NOTE: ISET3d will not run when both ISETCam and ISETBio are on your path. You can determine which is on your path using the ISET3d routine piCamBio, which returns true for ISETCam and false for ISETBio.

Making use of GPU Support

ISET3d-v4 can make use of PBRT-v4's GPU support under certain conditions:

1. Our Docker containers only support Nvidia GPUs with Compute Capability 6.0 or higher (local or remote)

2. You'll need to have an ISET3d-v4 Docker image for your configuration

Optional

ISETLens

The ISETLens toolbox is used from time-to-time in ISET3d to visualize and edit lenses. The toolbox is not used often or required for most things. But it is often useful for understanding.

Lightfield Toolbox

Donald Dansereau has written a useful Lightfield Toolbox for Matlab. We are organizing our data to take advantage of Donald's work, and we typically clone his repository into the external/ directory. We suggest that you use Donald's directory rather than the one placed on github by Hazirbas.