Metadata-Version: 2.4
Name: guppy-neuro
Version: 2.0.0b2
Summary: Guided Photometry Analysis in Python, a free and open-source fiber photometry data analysis tool.
Author: Michael Schaid, Jillian Seiler, Gabriela Lopez, Talia Lerner, Paul Adkisson-Floro, Luiz Tauffer
Author-email: Venus Sherathiya <venus.sherathiya@northwestern.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Talia Lerner and Venus Sherathiya
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/LernerLab/GuPPy
Project-URL: Documentation, https://guppy.readthedocs.io/
Keywords: neuroscience,fiber-photometry,calcium-imaging,data-analysis,gui,visualization,signal-processing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bokeh
Requires-Dist: datashader
Requires-Dist: h5py
Requires-Dist: holoviews
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: panel
Requires-Dist: param
Requires-Dist: platformdirs
Requires-Dist: pynwb>=4
Requires-Dist: scipy
Requires-Dist: statsmodels
Requires-Dist: tables
Requires-Dist: selenium
Requires-Dist: dandi
Requires-Dist: remfile
Requires-Dist: pyyaml
Requires-Dist: neuroconv[guppy]>=0.10.1
Requires-Dist: ndx-guppy>=0.2.0
Dynamic: license-file

[![DOI](https://zenodo.org/badge/382176345.svg)](https://zenodo.org/badge/latestdoi/382176345) [![Join the chat at https://gitter.im/LernerLab/GuPPy](https://badges.gitter.im/LernerLab/GuPPy.svg)](https://gitter.im/LernerLab/GuPPy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![codecov](https://codecov.io/gh/LernerLab/GuPPy/graph/badge.svg)](https://codecov.io/gh/LernerLab/GuPPy) [![Documentation Status](https://readthedocs.org/projects/guppy/badge/?version=latest)](https://guppy.readthedocs.io/)

<img src="https://raw.githubusercontent.com/LernerLab/GuPPy/main/assets/GuppyLogo.png" alt="GuPPy Logo" width="300">

Guided Photometry Analysis in Python, a free and open-source fiber photometry data analysis tool.

> **GuPPy 2.0 is in beta.** `pip install guppy-neuro` installs a pre-release. If you need a stable version, see [Older versions](#older-versions).

## Quick start

Requires Python 3.10 or greater. We recommend installing into a conda environment:

```bash
conda create -n guppy_env python=3.12
conda activate guppy_env
pip install guppy-neuro
```

Then launch the user interface:

```bash
guppy
```

See the [installation guide](https://guppy.readthedocs.io/en/latest/installation.html) for the full walkthrough, including installing conda and installing from source.

## Documentation

The GuPPy documentation lives at [guppy.readthedocs.io](https://guppy.readthedocs.io/): a [tutorial](https://guppy.readthedocs.io/en/latest/tutorials/index.html) walking through a first analysis end to end, [how-to guides](https://guppy.readthedocs.io/en/latest/how-to/index.html) for individual tasks, [explanations](https://guppy.readthedocs.io/en/latest/explanation/index.html) of how the analysis works, and a [reference](https://guppy.readthedocs.io/en/latest/reference/index.html) for every input parameter and output file.

## Citation

- If you use GuPPy for your research, please cite [Venus N. Sherathiya, Michael D. Schaid, Jillian L. Seiler, Gabriela C. Lopez, and Talia N. Lerner GuPPy, a Python toolbox for the analysis of fiber photometry data](https://www.nature.com/articles/s41598-021-03626-9)

> Venus N. Sherathiya, Michael D. Schaid, Jillian L. Seiler, Gabriela C. Lopez, and Talia N. Lerner GuPPy, a Python toolbox for the analysis of fiber photometry data. Sci Rep 11, 24212 (2021). https://doi.org/10.1038/s41598-021-03626-9

## Contributors

- [Venus Sherathiya](https://github.com/venus-sherathiya)
- [Michael Schaid](https://github.com/Mschaid)
- Jillian Seiler
- [Gabriela Lopez](https://github.com/glopez924)
- [Talia Lerner](https://github.com/talialerner)
- [Paul Adkisson-Floro](https://github.com/pauladkisson)

## Older versions

No GuPPy 2.0 stable release has been published yet. If you need a stable version, use **[GuPPy v1.3.0](https://github.com/LernerLab/GuPPy/releases/tag/v1.3.0)**. It predates the 2.0 rewrite and is not installable with `pip`: download the source from that release, then from inside the unpacked folder run

```bash
# Substitute spec_file_windows10.txt or spec_file_linux.txt for your OS.
conda create --name guppy --file spec_file_mac.txt
conda activate guppy
panel serve --show GuPPy/savingInputParameters.ipynb
```

v1.3.0 has a different interface and different parameters, so the documentation at guppy.readthedocs.io does not apply to it. Use the [GitHub Wiki](https://github.com/LernerLab/GuPPy/wiki) instead.
