openflexure_microscope_server

package documentation

The OpenFlexure Microscope Server Package.

The OpenFlexure Microscope Server is a LabThings-FastAPI server. All hardware interfaces, and almost all functionality exposed over HTTP is done using Things.

On the microscope the server is started by systemd. It can be controlled using commands such as ofm restart, ofm start, and ofm stop.

The server can also be run in simulation mode from the terminal. In the root directory of the repository the server can be started with run:

openflexure-microscope-server --fallback -c ./ofm_config_simulation.json
Module background_detect Provide functionality to detect if the camera is imaging sample or background.
Module logging Configure logging for the OpenFlexure Server.
Module scan_directories Functionality to manage file system operations for scan directories.
Module scan_planners Functionality for planning scan routes.
Package server A package responsible for, setup, booting, and shutting down the server.
Module stitching Communicate with OpenFlexure Stitching to perform stitches for scans.
Package things A package for all of the core LabThings-FastAPI Things shipped with the microscope.
Module ui Functionality for communicating the required user interface for a thing.
Module utilities Utility functions and classes.