# GuPPy

```{image} ../assets/GuppyLogo.png
:alt: GuPPy logo
:width: 300px
:align: center
```

**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, and visualization. Data formats supported include TDT, Doric, Neurophotometrics (NPM), and generic CSV.

## Installation

```bash
pip install guppy-neuro
```

Then launch the GUI:

```bash
guppy
```

```{toctree}
:maxdepth: 1
:caption: Contents

tutorials/index
how-to/index
explanation/index
reference/index
```

## Links

- [Source code](https://github.com/LernerLab/GuPPy)
- [PyPI package](https://pypi.org/project/guppy-neuro/)
- [Issue tracker](https://github.com/LernerLab/GuPPy/issues)
- [GitHub Wiki](https://github.com/LernerLab/GuPPy/wiki) (covers v1.3.0 and earlier; updated guides for v2 are being added here)