# pymmcore-plus

> Control microscopes with Python: Micro-Manager's core, acquisition engine, widgets, and apps.

Python tools for controlling microscopes with Micro-Manager: pymmcore-plus (core + acquisition engine), useq-schema (experiment schema), pymmcore-widgets (Qt widgets), pymmcore-gui and napari-micromanager (applications).

## Getting started

- [Home](<https://pymmcore-plus.github.io/index.md>)
- [Your First Acquisition](<https://pymmcore-plus.github.io/getting-started/first-acquisition/index.md>)
- [Your First GUI](<https://pymmcore-plus.github.io/getting-started/first-gui/index.md>)
- [First Steps](<https://pymmcore-plus.github.io/getting-started/first-steps/index.md>)
- [Coming from Micro-Manager](<https://pymmcore-plus.github.io/getting-started/from-micro-manager/index.md>)
- [Installation](<https://pymmcore-plus.github.io/getting-started/install/index.md>)
- [Which Package Do I Need?](<https://pymmcore-plus.github.io/getting-started/which-package/index.md>)

## User guide

- [User Guide](<https://pymmcore-plus.github.io/guide/index.md>)
- [Using Your Own Microscope](<https://pymmcore-plus.github.io/guide/own-microscope/index.md>)
- [Micro-Manager Device Adapters](<https://pymmcore-plus.github.io/pymmcore-plus/install/index.md>)
- [Configuration and Groups](<https://pymmcore-plus.github.io/pymmcore-plus/guides/configuration/index.md>)
- [Constants](<https://pymmcore-plus.github.io/pymmcore-plus/guides/constants/index.md>)
- [Custom Acquisition Engines](<https://pymmcore-plus.github.io/pymmcore-plus/guides/custom_engine/index.md>)
- [Devices and Properties](<https://pymmcore-plus.github.io/pymmcore-plus/guides/devices/index.md>)
- [Event-Driven Acquisition](<https://pymmcore-plus.github.io/pymmcore-plus/guides/event_driven_acquisition/index.md>)
- [Events and Callbacks](<https://pymmcore-plus.github.io/pymmcore-plus/guides/events/index.md>)
- [IPython Tab Completion](<https://pymmcore-plus.github.io/pymmcore-plus/guides/ipython_completion/index.md>)
- [Logging](<https://pymmcore-plus.github.io/pymmcore-plus/guides/logging/index.md>)
- [The Acquisition Engine](<https://pymmcore-plus.github.io/pymmcore-plus/guides/mda_engine/index.md>)
- [Saving Data](<https://pymmcore-plus.github.io/pymmcore-plus/guides/saving_data/index.md>)
- [UniMMCore](<https://pymmcore-plus.github.io/pymmcore-plus/guides/unicore/index.md>)
- [Building Sequences](<https://pymmcore-plus.github.io/useq-schema/guides/sequences/index.md>)
- [Qt Integration](<https://pymmcore-plus.github.io/pymmcore-plus/examples/integration-with-qt/index.md>)
- [Pycro-Manager-Style API](<https://pymmcore-plus.github.io/pymmcore-plus/examples/pycro-manager-api/index.md>)
- [Core and Device Adapters](<https://pymmcore-plus.github.io/pymmcore-plus/troubleshooting/index.md>)
- [Qt and Widgets](<https://pymmcore-plus.github.io/pymmcore-widgets/troubleshooting/index.md>)
- [Performance Profiling](<https://pymmcore-plus.github.io/pymmcore-plus/profiling/index.md>)
- [The useq-schema Package](<https://pymmcore-plus.github.io/useq-schema/index.md>)
- [useq-schema v2 (Preview)](<https://pymmcore-plus.github.io/useq-schema/v2-migration/index.md>)
- [Building a Custom GUI](<https://pymmcore-plus.github.io/pymmcore-widgets/getting_started/index.md>)
- [Widget Gallery](<https://pymmcore-plus.github.io/pymmcore-widgets/widgets/index.md>)
- [pymmcore-gui](<https://pymmcore-plus.github.io/pymmcore-gui/index.md>)
- [Installing pymmcore-gui](<https://pymmcore-plus.github.io/pymmcore-gui/install/index.md>)
- [Using pymmcore-gui](<https://pymmcore-plus.github.io/pymmcore-gui/usage/index.md>)
- [Install and Launch](<https://pymmcore-plus.github.io/napari-micromanager/getting_started/index.md>)
- [napari-micromanager](<https://pymmcore-plus.github.io/napari-micromanager/index.md>)
- [Scripting](<https://pymmcore-plus.github.io/napari-micromanager/scripting/index.md>)

## API reference

- [API Reference](<https://pymmcore-plus.github.io/api/index.md>)
- [pymmcore-plus](<https://pymmcore-plus.github.io/pymmcore-plus/index.md>)
- [pymmcore-widgets](<https://pymmcore-plus.github.io/pymmcore-widgets/index.md>)
- [core\_actions](<https://pymmcore-plus.github.io/pymmcore-gui/api/pymmcore_gui/actions/core_actions/index.md>)
- [pymmcore\_gui.actions](<https://pymmcore-plus.github.io/pymmcore-gui/api/pymmcore_gui/actions/index.md>)
- [widget\_actions](<https://pymmcore-plus.github.io/pymmcore-gui/api/pymmcore_gui/actions/widget_actions/index.md>)
- [pymmcore\_gui](<https://pymmcore-plus.github.io/pymmcore-gui/api/pymmcore_gui/index.md>)
- [pymmcore\_gui.widgets.image\_preview](<https://pymmcore-plus.github.io/pymmcore-gui/api/pymmcore_gui/widgets/image_preview/index.md>)
- [pymmcore\_gui.widgets](<https://pymmcore-plus.github.io/pymmcore-gui/api/pymmcore_gui/widgets/index.md>)
- [CMMCorePlus](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/CMMCorePlus/index.md>)
- [pymmcore\_plus.core.events](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/core/events/index.md>)
- [pymmcore\_plus.core](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/core/index.md>)
- [pymmcore\_plus.experimental](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/experimental/index.md>)
- [pymmcore\_plus.experimental.simulate](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/experimental/simulate/index.md>)
- [pymmcore\_plus.experimental.unicore](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/experimental/unicore/index.md>)
- [pymmcore\_plus](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/index.md>)
- [install](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/install/index.md>)
- [pymmcore\_plus.mda.events](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/mda/events/index.md>)
- [pymmcore\_plus.mda.handlers](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/mda/handlers/index.md>)
- [pymmcore\_plus.mda](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/mda/index.md>)
- [functions](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/metadata/functions/index.md>)
- [Metadata Schema](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/metadata/index.md>)
- [serialize](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/metadata/serialize/index.md>)
- [mocks](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/mocks/index.md>)
- [pymmcore\_plus.model](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/model/index.md>)
- [seq\_tester](<https://pymmcore-plus.github.io/pymmcore-plus/api/pymmcore_plus/seq_tester/index.md>)
- [CameraRoiWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/CameraRoiWidget/index.md>)
- [ChannelGroupWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ChannelGroupWidget/index.md>)
- [ChannelTable](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ChannelTable/index.md>)
- [ChannelWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ChannelWidget/index.md>)
- [ConfigGroupsEditor](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ConfigGroupsEditor/index.md>)
- [ConfigGroupsTree](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ConfigGroupsTree/index.md>)
- [ConfigWizard](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ConfigWizard/index.md>)
- [ConfigurationWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ConfigurationWidget/index.md>)
- [CoreLogWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/CoreLogWidget/index.md>)
- [DefaultCameraExposureWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/DefaultCameraExposureWidget/index.md>)
- [ExposureWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ExposureWidget/index.md>)
- [GridPlanWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/GridPlanWidget/index.md>)
- [GroupPresetTableWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/GroupPresetTableWidget/index.md>)
- [HCSWizard](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/HCSWizard/index.md>)
- [ImagePreview](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ImagePreview/index.md>)
- [InstallWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/InstallWidget/index.md>)
- [LiveButton](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/LiveButton/index.md>)
- [MDASequenceWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/MDASequenceWidget/index.md>)
- [MDAWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/MDAWidget/index.md>)
- [ObjectivesPixelConfigurationWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ObjectivesPixelConfigurationWidget/index.md>)
- [ObjectivesWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ObjectivesWidget/index.md>)
- [PixelConfigurationWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/PixelConfigurationWidget/index.md>)
- [PositionTable](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/PositionTable/index.md>)
- [PresetsWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/PresetsWidget/index.md>)
- [PropertiesWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/PropertiesWidget/index.md>)
- [PropertyBrowser](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/PropertyBrowser/index.md>)
- [PropertyWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/PropertyWidget/index.md>)
- [ShuttersWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ShuttersWidget/index.md>)
- [SnapButton](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/SnapButton/index.md>)
- [StageExplorer](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/StageExplorer/index.md>)
- [StageWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/StageWidget/index.md>)
- [TimePlanWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/TimePlanWidget/index.md>)
- [ZPlanWidget](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/ZPlanWidget/index.md>)
- [pymmcore\_widgets.config\_presets](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/config_presets/index.md>)
- [pymmcore\_widgets.device\_properties](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/device_properties/index.md>)
- [experimental](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/experimental/index.md>)
- [delay\_page](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/delay_page/index.md>)
- [devices\_page](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/devices_page/index.md>)
- [finish\_page](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/finish_page/index.md>)
- [pymmcore\_widgets.hcwizard](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/index.md>)
- [intro\_page](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/intro_page/index.md>)
- [labels\_page](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/labels_page/index.md>)
- [roles\_page](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/hcwizard/roles_page/index.md>)
- [pymmcore\_widgets](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/index.md>)
- [pymmcore\_widgets.useq\_widgets](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/useq_widgets/index.md>)
- [pymmcore\_widgets.useq\_widgets.points\_plans](<https://pymmcore-plus.github.io/pymmcore-widgets/api/pymmcore_widgets/useq_widgets/points_plans/index.md>)
- [useq](<https://pymmcore-plus.github.io/useq-schema/api/useq/index.md>)
- [pycromanager](<https://pymmcore-plus.github.io/useq-schema/api/useq/pycromanager/index.md>)
- [useq.v2](<https://pymmcore-plus.github.io/useq-schema/api/useq/v2/index.md>)
- [Axes](<https://pymmcore-plus.github.io/useq-schema/schema/axes/index.md>)
- [Event](<https://pymmcore-plus.github.io/useq-schema/schema/event/index.md>)
- [Hardware Autofocus Plan](<https://pymmcore-plus.github.io/useq-schema/schema/hardware_autofocus/index.md>)
- [Sequence](<https://pymmcore-plus.github.io/useq-schema/schema/sequence/index.md>)
- [Events](<https://pymmcore-plus.github.io/pymmcore-plus/reference/events/index.md>)
- [Command Line (mmcore)](<https://pymmcore-plus.github.io/pymmcore-plus/cli/index.md>)
- [Environment Variables](<https://pymmcore-plus.github.io/pymmcore-plus/env_var/index.md>)

## Contributing

- [How These Docs Work](<https://pymmcore-plus.github.io/contributing/docs/index.md>)
- [Contributing](<https://pymmcore-plus.github.io/contributing/index.md>)
- [Developing pymmcore-plus](<https://pymmcore-plus.github.io/pymmcore-plus/contributing/index.md>)
- [Developing pymmcore-widgets](<https://pymmcore-plus.github.io/pymmcore-widgets/contributing/index.md>)