API Reference¶

These pages are generated from the docstrings of each package. Each object is documented once, under the shortest path you can import it from (e.g. pymmcore_plus.CMMCorePlus, not pymmcore_plus.core.CMMCorePlus). Other modules that re-export it just link there.

pymmcore-plus

CMMCorePlus (all of the core's methods, marking what pymmcore-plus adds or changes), the acquisition engine, device objects, constants, metadata, and the mmcore command line tool.
useq-schema

MDASequence, MDAEvent, and the plans for each axis (time, z, positions, grids, autofocus).
pymmcore-widgets

One page for each widget, with a screenshot and an example. (The widget gallery is a quicker way to browse them.)
pymmcore-gui

The application's entry points (create_mmgui) and the actions and widgets you can use to extend it.

napari-micromanager has no public Python API of its own, but you can drive it from a script (see Scripting napari-micromanager).

Release notes for each package are on GitHub: pymmcore-plus, useq-schema, pymmcore-widgets, napari-micromanager.

Linking to these docs from your own project

Each package publishes an object inventory for mkdocstrings and intersphinx, e.g. https://pymmcore-plus.github.io/pymmcore-plus/objects.inv (or https://pymmcore-plus.github.io/objects.inv for everything).