feat: HCS Wizard Widget with useq WellPlatePlan

docs/widget_list.json

@@ -20,7 +20,8 @@
     "TimePlanWidget",
     "ZPlanWidget",
     "GridPlanWidget",
-    "MDASequenceWidget"
+    "MDASequenceWidget",
+    "HCSWizard"
   ],
   "camera_widgets": [
     "CameraRoiWidget",

examples/hcs_temp/calibration_circle.py

@@ -0,0 +1,38 @@
+from contextlib import suppress
+
+from pymmcore_plus import CMMCorePlus
+from qtpy.QtWidgets import QApplication
+from useq import WellPlate
+
+from pymmcore_widgets.hcs._calibration_widget._calibration_widget import (
+    _CalibrationData,
+    _PlateCalibrationWidget,
+)
+
+with suppress(ImportError):
+    from rich import print
+
+
+plate = WellPlate(rows=8, columns=12, well_spacing=(9, 9), well_size=(6.4, 6.4))
+
+app = QApplication([])
+
+mmc = CMMCorePlus.instance()
+mmc.loadSystemConfiguration()
+
+cb = _PlateCalibrationWidget(mmcore=mmc)
+
+cb.setValue(
+    _CalibrationData(
+        plate=plate,
+        calibration_positions_a1=[(-10, 0), (0, 10), (10, 0)],
+        calibration_positions_an=[(90, 0), (100, 10), (110, 0)],
+    )
+)
+cb._calibration_mode._mode_combo.setCurrentIndex(1)
+
+cb.valueChanged.connect(print)
+
+cb.show()
+
+app.exec()

examples/hcs_temp/calibration_rectangle.py

@@ -0,0 +1,37 @@
+from contextlib import suppress
+
+from pymmcore_plus import CMMCorePlus
+from qtpy.QtWidgets import QApplication
+from useq import WellPlate
+
+from pymmcore_widgets.hcs._calibration_widget._calibration_widget import (
+    _CalibrationData,
+    _PlateCalibrationWidget,
+)
+
+with suppress(ImportError):
+    from rich import print
+
+
+plate = WellPlate(
+    rows=1, columns=1, well_spacing=(0, 0), well_size=(22, 22), circular_wells=False
+)
+
+app = QApplication([])
+
+mmc = CMMCorePlus.instance()
+mmc.loadSystemConfiguration()
+
+cb = _PlateCalibrationWidget(mmcore=mmc)
+
+cb.setValue(
+    _CalibrationData(
+        plate=plate,
+        calibration_positions_a1=[(-100, 100), (100, -100)],
+    )
+)
+cb.show()
+
+cb.valueChanged.connect(print)
+
+app.exec()

examples/hcs_temp/fov_selector.py

@@ -0,0 +1,23 @@
+from contextlib import suppress
+
+with suppress(ImportError):
+    pass
+
+from qtpy.QtWidgets import QApplication
+from useq import WellPlate
+
+from pymmcore_widgets.hcs._fov_widget._fov_sub_widgets import Center
+from pymmcore_widgets.hcs._fov_widget._fov_widget import _FOVSelectorWidget
+
+app = QApplication([])
+
+plate = WellPlate(rows=8, columns=12, well_spacing=(9, 9), well_size=(6.4, 6.4))
+fs = _FOVSelectorWidget(
+    plate=plate, mode=Center(x=0, y=0, fov_width=512, fov_height=512)
+)
+
+fs.valueChanged.connect(print)
+
+fs.show()
+
+app.exec()

examples/hcs_temp/plate_selector.py

@@ -0,0 +1,18 @@
+from contextlib import suppress
+
+with suppress(ImportError):
+    from rich import print
+
+from qtpy.QtWidgets import QApplication
+
+from pymmcore_widgets.hcs._plate_widget import _PlateSelectorWidget
+
+app = QApplication([])
+
+ps = _PlateSelectorWidget()
+
+ps.valueChanged.connect(print)
+
+ps.show()
+
+app.exec()

examples/hcs_wizard.py

@@ -0,0 +1,52 @@
+from contextlib import suppress
+
+from pymmcore_plus import CMMCorePlus
+from qtpy.QtWidgets import QApplication
+
+with suppress(ImportError):
+    from rich import print
+
+from useq import GridRowsColumns, WellPlate, WellPlatePlan
+
+from pymmcore_widgets.hcs import HCSWizard
+
+app = QApplication([])
+mmc = CMMCorePlus.instance()
+mmc.loadSystemConfiguration()
+w = HCSWizard()
+
+fov_width = mmc.getImageWidth() * mmc.getPixelSizeUm()
+fov_height = mmc.getImageHeight() * mmc.getPixelSizeUm()
+
+plate = WellPlate(
+    rows=8, columns=12, well_spacing=(9, 9), well_size=(6.4, 6.4), name="96-well"
+)
+wpp = WellPlatePlan(
+    plate=plate,
+    a1_center_xy=(0, 0),
+    rotation=3,
+    selected_wells=(slice(1, 7), slice(1, 11)),
+    well_points_plan=GridRowsColumns(
+        rows=3, columns=3, fov_width=fov_width, fov_height=fov_height, overlap=-100
+    ),
+)
+w.setValue(wpp)
+
+w.valueChanged.connect(print)
+
+
+# override the accept method to show the plot
+def _accept():
+    value = w.value()
+    print(value)
+    # execute only if matplotlib is available
+    with suppress(ImportError):
+        if value is None:
+            return
+        print(value.plot())
+
+
+w.accept = _accept
+
+w.show()
+app.exec()

pyproject.toml

@@ -51,9 +51,12 @@ dependencies = [
     'pymmcore-plus[cli] >=0.11.0',
     'qtpy >=2.0',
     'superqt[quantity] >=0.5.3',
-    'useq-schema >=0.4.7',
+    'useq-schema @ git+https://github.com/pymmcore-plus/useq-schema.git',  # temporary until new useq release
 ]
 
+[tool.hatch.metadata]
+allow-direct-references = true
+
 # extras
 # https://peps.python.org/pep-0621/#dependencies-optional-dependencies
 [project.optional-dependencies]
@@ -174,4 +177,5 @@ ignore = [
 ]
 
 [tool.typos.default]
-extend-ignore-identifiers-re = ["(?i)ome"]
+extend-ignore-identifiers-re = ["(?i)nd2?.*", "(?i)ome", "FO(Vs?)?"]
+

src/pymmcore_widgets/__init__.py

@@ -28,6 +28,7 @@
 from ._shutter_widget import ShuttersWidget
 from ._snap_button_widget import SnapButton
 from ._stage_widget import StageWidget
+from .hcs import HCSWizard
 from .hcwizard import ConfigWizard
 from .mda import MDAWidget
 from .useq_widgets import (
@@ -78,6 +79,7 @@ def __getattr__(name: str) -> object:
     "ExposureWidget",
     "GridPlanWidget",
     "GroupPresetTableWidget",
+    "HCSWizard",
     "ImagePreview",
     "InstallWidget",
     "LiveButton",

src/pymmcore_widgets/hcs/__init__.py

@@ -0,0 +1,5 @@
+"""HCS Wizard."""
+
+from ._main_wizard._main_wizard import HCSWizard
+
+__all__ = ["HCSWizard"]