An open API service indexing awesome lists of open source software.

https://github.com/pymmcore-plus/pymmcore-widgets

A set of Qt-based widgets onto the pymmcore-plus model
https://github.com/pymmcore-plus/pymmcore-widgets

gui micro-manager microscopy python

Last synced: 4 months ago
JSON representation

A set of Qt-based widgets onto the pymmcore-plus model

Awesome Lists containing this project

README

          

# pymmcore-widgets

[![License](https://img.shields.io/pypi/l/pymmcore-widgets.svg?color=green)](https://github.com/pymmcore-plus/pymmcore-widgets/raw/main/LICENSE)
[![Python Version](https://img.shields.io/pypi/pyversions/pymmcore-widgets.svg?color=green)](https://python.org)
[![PyPI](https://img.shields.io/pypi/v/pymmcore-widgets.svg?color=green)](https://pypi.org/project/pymmcore-widgets)
[![Conda](https://img.shields.io/conda/vn/conda-forge/pymmcore-widgets)](https://anaconda.org/conda-forge/pymmcore-widgets)
[![CI](https://github.com/pymmcore-plus/pymmcore-widgets/actions/workflows/ci.yml/badge.svg)](https://github.com/pymmcore-plus/pymmcore-widgets/actions/workflows/ci.yml)
[![docs](https://github.com/pymmcore-plus/pymmcore-plus/actions/workflows/docs.yml/badge.svg)](https://pymmcore-plus.github.io/pymmcore-widgets/)
[![codecov](https://codecov.io/gh/pymmcore-plus/pymmcore-widgets/branch/main/graph/badge.svg)](https://codecov.io/gh/pymmcore-plus/pymmcore-widgets)

A set of widgets for the [pymmcore-plus](https://github.com/pymmcore-plus/pymmcore-plus) package.
This package can be used to build custom user interfaces for micromanager in a python/Qt environment.
It forms the basis of [`napari-micromanager`](https://github.com/pymmcore-plus/napari-micromanager)

### [:book: Documentation](https://pymmcore-plus.github.io/pymmcore-widgets)

mm_widgets

See complete list of available widgets in the [documentation](https://pymmcore-plus.github.io/pymmcore-widgets/#widgets)

## Installation

```sh
pip install pymmcore-widgets

# note that this package does NOT include a Qt backend
# you must install manually, or using an extra, e.g.:
pip install pymmcore-widgets[PyQt6]
pip install pymmcore-widgets[PySide6]

# package is tested against PyQt6, and PySide6, we no longer test PyQt5/PySide2
```

## Development

Install [uv](https://docs.astral.sh/uv/getting-started/installation/)

```sh
git clone
cd pymmcore-widgets
uv sync
```

### Testing

```sh
uv run pytest
```

### Docs

```sh
uv run --group docs mkdocs serve
```