twopy 0.2.0

Two-photon imaging analysis tool with a napari interface.

twopy

Two-photon imaging analysis tool for the Clark Lab output format.

Getting Started

twopy lets you open two-photon recordings, draw ROIs, plot responses in real time, process and analyze them, and save them.

When you first load a recording, twopy converts it to a standardized HDF5 format. The converted format includes the aligned movie, mean image, stimulus tables, photodiode signals, and recording metadata. Analysis and the GUI both work from the converted files, so the original source files remain separate from twopy's outputs. By default, converted recordings and interactive analysis outputs are cached locally under ~/.cache/twopy/recordings for speed; saving ROIs and analysis publishes the changed output files back to the configured analysis_output location in the background.

Install

Examples use micromamba, but any conda-compatible environment manager should work.

micromamba create -n twopy -c conda-forge python=3.13 pip -y
micromamba run -n twopy python -m pip install twopy

Verify the install:

micromamba run -n twopy python -c 'import twopy; print(twopy.__name__)'

For a source checkout, copy config.example.yml to config.yml and edit the paths for your computer. config.yml stays local and is not tracked by git.

Start

micromamba activate twopy
twopy

Open a source recording or converted recording directly:

twopy /path/to/source/recording
twopy /path/to/recording_data.h5

Basic GUI flow:

1. Search the database or load a recording manually.
2. Draw or edit ROIs in the rois Labels layer.
3. Update response plots from the current ROIs.
4. Click Save ROIs + analysis in Export when the plots look right.

When a source recording has not been converted yet, twopy converts it first. Converted data includes the aligned movie, mean image, stimulus tables, photodiode signals, and recording metadata.

Docs

• GUI guide: napari loading, ROI editing, plotting, and saved outputs.
• Python API guide: find recordings, convert data, run analysis, and open napari from scripts.
• Custom workflow guide: add versioned local analyses to the napari Custom tab.
• Development guide: source setup and local checks.
• Input data spec: short recording folder contract.
• Recording file reference: detailed source and converted file schema.

Check

micromamba run -n twopy pre-commit run --all-files