ConfigWizard¶

Example¶

examples/config_wizard.py
from pymmcore_plus import CMMCorePlus
from qtpy.QtWidgets import QApplication

from pymmcore_widgets import ConfigWizard

app = QApplication([])

mmc = CMMCorePlus.instance()
mmc.loadSystemConfiguration()

wiz = ConfigWizard()
wiz.show()

app.exec()

API¶

Bases: QWizard

Hardware Configuration Wizard for Micro-Manager.

It can be used to create a new configuration file or edit an existing one.

Parameters:

Name	Type	Description	Default
`config_file`	`str`	Path to a configuration file to load, by default "".	`''`
`core`	`CMMCorePlus`	A CMMCorePlus instance, by default, uses the global singleton. (Note that this parameter is called `core`, where other widgets use `mmcore`.)	`None`
`parent`	`QWidget`	The parent widget, by default None.	`None`

Referenced by:

API Reference pymmcore-widgets pymmcore_widgets hcwizard Re-exports
Getting Started Your First GUI Building your own
User Guide
- Controlling Hardware Using Your Own Microscope Making a configuration file
- Widget Gallery
  - Building a Custom GUI Choosing a core
  - Configuration and setup

Returned by:

API Reference pymmcore-gui pymmcore_gui
- actions widget_actions Functions create_config_wizard
- Classes MicroManagerGUI get_widget

microscopeModel ¶

microscopeModel() -> Microscope

Return the microscope model.

save ¶

save(path: str | Path) -> None

Save the configuration to a file.

accept ¶

accept() -> None

Accept the wizard and save the configuration to a file.

reject ¶

reject() -> None

Reject the wizard and reload the prior configuration.