Getting Started

This page gets you from zero to a running mesoSPIM-control session in demo mode — no physical hardware required.

Prerequisites

  • OS: Windows 7 or later, 64-bit

  • Python: 3.12 (we recommend Miniforge and its mamba package manager)

Note

The Anaconda distribution is not recommended due to its changed terms of service. If you already have Anaconda, replace mamba with conda in every command below.

Step 1 — Clone the repository

Clone (or download) this repository into a convenient location, for example:

C:/Users/Public/mesoSPIM-control

Using GitHub Desktop is the easiest option. Alternatively, download and unpack the ZIP archive from the GitHub releases page.

GitHub Desktop clone dialog

Step 2 — Create a Python environment

Open a Miniforge prompt and run:

mamba create -p C:/Users/Public/mamba/envs/mesoSPIM-py312 python=3.12
mamba activate C:/Users/Public/mamba/envs/mesoSPIM-py312

Step 3 — Install dependencies

cd C:/Users/Public/mesoSPIM-control
pip install -r requirements-conda-mamba.txt

Step 4 — Launch in demo mode

From the Miniforge prompt:

cd C:/Users/Public/mesoSPIM-control/mesoSPIM
python mesoSPIM_Control.py -D

The -D flag enables demo mode, replacing every hardware device with a software simulator so you can explore the full GUI without any connected equipment.

What’s next?

Installation

Install device drivers and set up a real hardware system.

Configuration

Write a config file that maps to your specific hardware.

User Guide

Learn the GUI, acquisition modes, and scripting interface.

Supported Hardware

See all supported cameras, stages, filter wheels, and lasers.