msw-open-ephys 3.2.0

Remote control for Open Ephys GUI v1+ — session naming and recording management

msw-open-ephys

Remote control for Open Ephys GUI v1+ — session naming, recording management, and metadata writing for MSW acquisition workflows.

Install

pip install msw-open-ephys

Or editable from the repo:

pip install -e external/msw-open-ephys

CLI

oe-remote status   --remote-ip 10.0.10.111
oe-remote preview  --remote-ip 10.0.10.111
oe-remote record   --remote-ip 10.0.10.111 --subject m1099 \
                   --acquisition-extension ephys_multi_behavior \
                   --session-extension pxi
oe-remote record   --remote-ip 10.0.10.111 --subject m1099 \
                   --session-extension intan_ttl --child @last
oe-remote stop     --remote-ip 10.0.10.111

Session modes

Mode	When	OE records to
Standalone	no --acquisition-extension, no --child	remote/{subject}/{subject__dt__session}/
Parent	--acquisition-extension set	remote/{subject}/{subject__dt__acq}/{subject__dt__session}/
Child	--child ACQ_PATH or --child @last	remote/{acq_path}/{subject__dt__session}/

--child @last reuses the acquisition path cached by the most recent parent or record command.

Python API

from msw_open_ephys.controller import OEController
from msw_open_ephys.session import Session

oe = OEController(ip="10.0.10.111")
oe.preview()
oe.configure_recording(parent_directory=r"E:\OE_DATA", base_text="m1099/acq/session")
oe.record()

Integration with MSW

msw run --parent openephys calls the OE REST API directly via murineshiftwork.hardware.parent_session (uses open-ephys-python-tools, not this package). This package provides the oe-remote CLI used to start the acquisition side before launching MSW tasks.

Set open_ephys_url in the setup YAML so MSW can attach automatically:

# msw_configs/setups/setup-npxb.yaml
open_ephys_url: 10.0.10.111