Metadata-Version: 2.4
Name: ephyspy
Version: 0.0.8
Summary: Package to extract summary statistics from electrophysiological data.
Author: Jonas Beck
License: GPL-3.0-or-later
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Requires-Dist: matplotlib>=3.4.2
Requires-Dist: numpy>=1.20.0
Requires-Dist: pandas>=1.5.3
Requires-Dist: scikit-learn>=1.1.1
Requires-Dist: scipy>=1.9.1
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: ipython>=8.12.3; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: jupyter-black>=0.4.0; extra == 'dev'
Requires-Dist: jupyter>=1.1.1; extra == 'dev'
Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
Requires-Dist: pytest>=8.3.5; extra == 'dev'
Requires-Dist: seaborn>=0.13.2; extra == 'dev'
Description-Content-Type: text/markdown

<!-- [![DOI]()]() -->
[![PyPI version](https://badge.fury.io/py/ephyspy.svg)](https://badge.fury.io/py/ephyspy)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/berenslab/ephyspy/blob/main/CONTRIBUTING.md)
[![Tests](https://github.com/berenslab/ephyspy/workflows/Tests/badge.svg?branch=main)](https://github.com/berenslab/ephyspy/actions)
[![codecov](https://codecov.io/gh/berenslab/ephyspy/branch/main/graph/badge.svg)](https://codecov.io/gh/berenslab/ephyspy)
[![GitHub license](https://img.shields.io/github/license/berenslab/ephyspy)](https://github.com/berenslab/ephyspy/blob/main/LICENSE.txt)
[![Documentation Status](https://readthedocs.org/projects/ephyspy/badge/?version=latest)](https://ephyspy.readthedocs.io/en/latest/?badge=latest)

# EphysPy

### Package to extract electrophysiological features from current clamp experiments.

This package provides an API to extract a multitude of features from voltage clamp recordings with the help of the [AllenSDK](https://allensdk.readthedocs.io/en/latest/allensdk.ephys.html). 

### Installation
The package can be installed via `pip install ephyspy`.
Alternatively, clone the package with `https://github.com/berenslab/ephyspy.git` and install using pip via `pip install -e ./ephyspy`.

### Getting started
To get started see [`example.ipynb`](https://github.com/berenslab/ephyspy/blob/main/example.ipynb).

### Documentation
All documentation can be found [here](https://ephyspy.readthedocs.io/en/latest).

### Acknowledgments
This package builds on previous work by @ybernaerts, which was part of the [Phenotypic variation of transcriptomic cell types in mouse motor cortex atlas](https://github.com/berenslab/mini-atlas) and the [AllenSDK](https://allensdk.readthedocs.io/en/latest/allensdk.ephys.html).