Skip to content

GUI interface between napari and micromanager powered by pymmcore-plus and pymmcore-widgets

License

Notifications You must be signed in to change notification settings

pymmcore-plus/napari-micromanager

Repository files navigation

napari-micromanager

License PyPI Python Version Tests codecov

GUI interface between napari and micromanager powered by pymmcore-plus and pymmcore-widgets

Note

While this plugin will continue to be maintained, we are focusing current efforts on a napari-independent gui (using ndv) for reasons of performance and minimizing dependencies. Please follow https://github.com/pymmcore-plus/pymmcore-gui for details


napari-micromanager

Installation

You can install napari-micromanager via pip:

pip install napari-micromanager

You will also need a Qt backend such as PySide2/6, or PyQt5/6. PyQt is preferred and receives more testing. If you've previously installed napari into this environment with pip install napari[all], then you will likely already have it. If not, you will also need to install a Qt backend of your choice:

pip install pyqt5  # or any of {pyqt5, pyqt6, pyside2, pyside6}

Getting micromanager adapters

The easiest way to get the micromanager adapters is to use:

mmcore install

this will install micromanager to the pymmcore_plus folder in your site-package; use this to see where:

python -c "from pymmcore_plus import find_micromanager; print(find_micromanager())"

alternatively, you can direct pymmcore_plus to your own micromanager installation with the MICROMANAGER_PATH environment variable:

export MICROMANAGER_PATH='/path/to/Micro-Manager-...'

Contributing

Contributions are very welcome.

Launching napari with plugin

You can launch napari and automatically load this plugin using the launch-dev.py script:

python launch-dev.py

Alternatively you can run:

napari -w napari-micromanager

License

Distributed under the terms of the BSD-3 license, "napari-micromanager" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.