User Guides#
Welcome to waveorder’s documentation#
We have organized our documentation by user type and intended task.
Software users#
Reconstruct existing data: start with the reconstruction guide and consult the data schema for waveorder’s data format.
Reconstruct with a GUI: start with the plugin’s reconstruction guide.
Integrate waveorder into my software: start with examples/
Hardware users#
Buy hardware for a polarized-light installation: start with the buyer’s guide.
Install waveorder on my microscope: start with the microscope installation guide.
Use the napari plugin to calibrate: start with the plugin guide.
Understand waveorder’s calibration routine: read the calibration guide.
Software developers#
Set up a development environment and test waveorder: start with the development guide.
Report an error in the documentation or code: open an issue or send us an email. We appreciate your help!