OpenScope Experimental Launcher Documentation
Windows-only experimental launcher for OpenScope Bonsai workflows with metadata generation and session tracking.
Overview
The OpenScope Experimental Launcher is a Windows-specific package designed to manage and execute Bonsai-based neuroscience experiments in the OpenScope project. It provides robust process management, parameter handling, session tracking, and metadata generation capabilities.
Key Features
- 🔧 Bonsai Process Management
Start, monitor, and manage Bonsai workflow execution with Windows-specific process control
- 📊 Session Tracking
Generate unique session IDs and comprehensive experiment metadata
- 🗂️ Parameter Management
Load and validate experiment parameters from JSON configuration files
- 🔄 Git Repository Management
Automatic cloning and version control of workflow repositories
- 📈 Process Monitoring
Memory usage monitoring and automatic handling of runaway processes
- 🎯 Multi-Rig Support
Specialized launchers for different experimental rigs (SLAP2, etc.)
Quick Start
Installation:
pip install -e .
Basic Usage:
from openscope_experimental_launcher.base.experiment import BaseExperiment # Create and run experiment experiment = BaseExperiment() success = experiment.run("path/to/parameters.json")
Parameter File Example:
Architecture
The package consists of several key components:
BaseExperiment: Core experiment launcher with Bonsai process management
SLAP2Experiment: Specialized launcher for SLAP2 imaging experiments
Utility Classes: Configuration loading, Git management, process monitoring
System Requirements
Warning
This package is Windows-only and requires:
Windows 10 or Windows 11
Python 3.8 or higher
Bonsai (installed separately)
Git for repository management
Contents
User Guide
Additional Resources