User Guide¶
The User Guide is organized by topic, roughly following the stack from the hardware up. Each page belongs to one package's docs (the badge at the top says which), and names of classes and functions link to the API reference. If you're new here, Getting Started is probably a better place to begin.
-
Controlling hardware
Installing device adapters, using your own microscope, devices and properties, configuration groups, and events and callbacks (which are how GUIs, and your own code, stay in sync with the core).
-
Describing experiments
How useq-schema describes an acquisition as a sequence of events, and building sequences with time points, z-stacks, channels, positions, grids, etc...
-
Running acquisitions
The acquisition engine, saving data, event-driven acquisition, and writing your own engine.
-
Building GUIs
The widget gallery, building a custom GUI from those widgets, and keeping it responsive.
-
Applications
pymmcore-gui, our desktop application, and napari-micromanager, which controls a microscope from inside napari.
-
Advanced topics
Device adapters written in Python (
UniMMCore), a preview of useq-schema v2, and a Pycro-Manager-style API.
Something not working?
The troubleshooting pages cover the core and device adapters and Qt and widgets. Turning up the logging (or profiling, if things are slow) can also help you work out what's going on. If you're still stuck, please ask on the image.sc forum.