Open Ephys Miniscope GUI

A self-contained ImGui-based graphical interface for configuring and acquiring data from a UCLA Miniscope V4 head-borne miniature microscope, including control of an Open Ephys commutator.

It wraps the acquisition node from OpenEphys.Miniscope in a single-window GUI (settings panel, live video/data display, file recording controls, and a status/console log).

Full hardware and experiment documentation: https://open-ephys.github.io/miniscope-docs/.

Installing

As a standalone application

Download the latest MiniscopeV4Gui-Setup-*.exe from the Releases page and run it. The installer:

• Installs to your user profile (no admin rights required).
• Downloads all dependencies (Bonsai and required packages) so no separate Bonsai install is needed.
• Adds Start Menu / Desktop shortcuts to launch the GUI.

Note

The GUI is currently in beta, and has not been released on GitHub yet. To download the GUI while it is in beta, please refer to the Software Guide for instructions on how to download and install the GUI.

As a Bonsai package

Add the OpenEphys.Miniscope.Gui package through Bonsai's package manager, then drop the MiniscopeV4Gui.bonsai workflow into the editor.

Note

The GUI is currently in beta, and has not been released on NuGet yet. To download the GUI while it is in beta, please refer to the Software Guide for instructions on how to download and install the GUI package.

Developing

Prerequisites: Visual Studio 2026, and a Windows machine.

1. Clone the repository and open OpenEphys.Miniscope.Gui.sln.
2. Double-click .bonsai\Setup.cmd once. This downloads a copy of Bonsai into .bonsai\ and restores the packages listed in .bonsai\Bonsai.config.
3. Build the solution; this automatically generates a OpenEphys.Miniscope.Gui\Configuration\Settings.cs file containing generated classes based on the OpenEphys.Miniscope.Gui\Configuration\miniscope-config.schema.json schema.
4. The main GUI workflow lives at OpenEphys.Miniscope.Gui\Workflows\MiniscopeV4Gui.bonsai.

License

MIT