pymmcore-plus¶
pymmcore-plus aims to extend
pymmcore (Python bindings for the
C++ Micro-Manager core)
with a number of features designed to facilitate working with Micro-Manager in
pure Python/C environments. The main object in this library,
CMMCorePlus, aims to be a drop-in replacement for
pymmcore.CMMCore, while adding a number of additional features including:
- A multi-dimensional acquisition engine implemented in pure Python. (The existing acquisition engines in Micro-Manager are written in Java and Clojure.)
- More flexible event connections and callback handling.
- Extended convenience APIs for working with the core (which would be hard or
impossible to implement in the
pymmcoreSWIG wrapper). - More pythonic APIs for various pymmcore objects (e.g.
Device,Configuration) and constants.
Where to start¶
If you're new here, start with Installation (which includes getting the Micro-Manager device adapters), then First steps and Your first acquisition. The User Guide goes into more depth on devices and properties, configuration groups, events, running acquisitions and saving data.
Reference¶
CMMCorePlus: every method of the core, with whatpymmcore-plusadds or overrides marked.pymmcore_plus.mda: the acquisition runner (MDARunner) and engine (MDAEngine).- Events: the signals emitted by
core.eventsandcore.mda.events. - Metadata schema: the metadata dicts that come with each acquired frame.
- Constants: the enums that replace pymmcore's integer constants.
- Command line (
mmcore) and environment variables.