GuPPy#

GuPPy logo

Guided Photometry Analysis in Python is an open-source tool for processing and analyzing fiber photometry recordings. It provides a GUI-based pipeline covering raw data ingestion, signal preprocessing, PSTH computation, transient detection, visualization, and export to NWB. Data formats supported include TDT, Doric, Neurophotometrics (NPM), NWB, and generic CSV.

Installation

Set up a conda environment and install GuPPy from PyPI or from source.

Installation
Tutorials

Learning-oriented guides that walk you through a complete workflow from start to finish. Start here if you are new to GuPPy.

Tutorials
How-to Guides

Task-oriented recipes for readers who already know what they want to accomplish.

How-to Guides
Explanation

Background and context: the science behind fiber photometry, the design of the GuPPy pipeline, and the reasoning behind key parameter choices.

Explanation
Reference

Lookup material: every input parameter the GUI exposes, every file GuPPy writes, and the vocabulary GuPPy uses for its data entities.

Reference
Contributor’s Guide

Get oriented in the codebase: pipeline architecture, the test suite, and how to add support for a new recording format.

Contributor’s Guide