User guide

This user guide provides instructions, examples, and explanations to help you effectively use Visisipy for simulating and analyzing visual systems.

Refer to the sections below to learn about installation, normal simulation workflow, and advanced usage.

Tip

Most sections in this user guide are Jupyter notebooks. You can download them using the Download notebook link in the right sidebar.

Getting started

• Installation
  • Enabling GPU Acceleration
• Simple example
  • Import visisipy and other dependencies
  • Define and build the eye model
  • Perform a raytrace analysis
  • Visualize the eye model and the raytrace results

Simulation workflow

• Defining eye models
  • Eye geometry
  • Eye materials
  • Building the model
  • Using predefined eye models
• Configuring the backend
  • Setting the backend
  • Updating settings
  • Getting the backend
  • Getting the optical system
• Performing analyses
  • Analyses available in Visisipy
  • Adding fields and wavelengths on the fly
  • Accuracy of analyses for both backends
  • Visualizing eye models

Advanced usage

• Interacting with the backend directly
  • Examples
  • Using multiple backends simultaneously
• Defining custom surface types
  • Generic surface definition
  • Backend-specific implementation
  • Surface factory function
  • Testing the implementation
  • Contributing custom surfaces
• Notes on asymmetric models