PhoPro

A comprehensive toolkit for the processing, analysis, and simulation of fiber photometry data

Overview

This package provides extensive functionaly for processing, handling, analyzing, and bulk processing fiber photometry datasets while remaining highly customizable. The high level APIs only require basic programming experience. It is built around 4 cores modules:

• PhotometryLoader - loads various photometry data formats.

• PhotometryExperiment - processes and windows photometry experiments.

• PhotometryData - handles trial-wise signals and metadata with advanced filtering, averaging, windowing, and analysis functionality.

• PhotometryPipeline - handles highly-customizable bulk processing of photometry data.

With an additional module for rigorously simulating complex photometry data:

• SimulatedPhotometry - simulates photometry traces with realistic photobleaching, movement artifacts, and custom event dynamics.

Documentation

Documentation for this package can be found here. It is built with mkdocs-material and hosted on GitHub pages.

Installation

You can now install through PyPi:

pip install PhoPro

Or you can install directly from GitHub using the command:

pip install git+https://github.com/ggolde/PhoPro.git

See the Installation page of the docs for more details.

Planned Features

This package is in ongoing development, please suggest any features you would like to see implemented on the issues page. Below are a few planned features:

• Implement import support for more formats.
• More methods for artifact detection and correction.
• Easier APIs for the cluster based permutation test and functional mixed modeling.
• Phase out "variants" modules.
• Improve windowing in PhotometryData.

License

MIT License.

Authors

This package is developed and used internally at the Bizon-Setlow Lab at the University of Florida.

Griffin Golde: University of Florida, contact: ggolde@ufl.edu

Citations

If you use this package in your work, and want to support the package, use the citation below (a proper publication is hopefully on the horizon):

• Golde G. PhoPro: Python toolkit for simulating, processing, handling, and analyzing fiber photometry data. GitHub repository. Version 0.6.0. Available at: https://github.com/ggolde/PhoPro.

Additionally, if you used the FMM module, please review the recommended reference(s) for the fast-fmm-rpy2 package.