Installation

From PyPI (recommended)

You can install directly SLM controller from PyPI using the following command:

pip install SLMcontroller

afterwards you can run the following command to start the software:

python3 -m SLMcontroller

or

SLMcontroller

From source

Download the latest stable release here. You can use either the precompiled binaries or compile the source code yourself.

Once downloaded move the folder SLMcontroller to a location of your choice. I will refer to this location as <INSTALLATION_PATH>.

First step is to install all the necessary dependencies (see below). Do so by running the following command:

pip3 install -r <INSTALLATION_PATH>/SLMcontroller/requirements.txt

Then, you can run the following command to start the software:

python3 <INSTALLATION_PATH>/SLMcontroller/SLMcontroller.py

The following GUI should appear on your screen:

See the How to section for more information on how to use the software.

Dependencies

The following dependencies are required to run SLM controller:

• Flask: Used for remote control of the SLM.

• PyQt6: Used for the GUI.

• Gmsh: Used for meshing the SLM surface.

• Numba: Used for accelerating the computation of the phase patterns.

• NumPy: Handling mathematical operations.

• OpenCV: Used for image processing (when optimizing for aberration using a camera).

• Pillow: Used to show remotely the phase patterns of the SLM.

You can use pip install -r docs/requirements.txt to install all the required dependencies directly.