Installation

The ISET3d toolbox dependencies are described here.

NOTE: We have started development on ISET3d-v4 -- using PBRT-v4. We expect to transition our mainline efforts around February, 2022.

Required

Matlab

ISET3d relies on Matlab's image processing and signal processing toolboxes. ISETBio and ISET3d-v4 will require the parallel computing toolbox.

Docker

To render, you must be able to run Linux Docker containers on your computer. They can be run on Linux (of course) Mac, and Window using WSL2. On Windows, however there are some file path issues. We've addressed many of them, but there are still a few that can pop up.

Docker installation instructions are here.

The tutorial ISET3d scripts automatically pull the correct docker image, as long as you have Docker installed and running on your machine. We are now relying on PBRT version 3 as the default. The Docker image that we use can be downloaded from dockerhub directly using the following command:

docker pull vistalab/pbrt-v3-spectral

Note: If needed, you can increase the resources available to Docker Engine when rendering a larger (or high resolution) scene. (Preferences -> Advanced -> Memory). One configuration that seems OK is CPUs 4, Memory 12 GB, Swap 2GB.

ISETCam or ISETBio

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

• ISETCam is downloaded using: git clone http://github.com/ISET/isetcam.git
• ISETBio is downloaded using: git clone https://github.com/isetbio/isetbio.git

ISET3d will not run when both are on your path. You can determine which is on your path using the ISET3d routine ieCamOrBio.

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 very 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.