Skip to main content

PYthon Neural Analysis Package Pour Laboratoires d’Excellence

Project description

image pynapple CI codecov GitHub issues GitHub contributors Twitter Follow

PYthon Neural Analysis Package.

pynapple is a light-weight python library for neurophysiological data analysis. The goal is to offer a versatile set of tools to study typical data in the field, i.e. time series (spike times, behavioral events, etc.) and time intervals (trials, brain states, etc.). It also provides users with generic functions for neuroscience such as tuning curves and cross-correlograms.

Note :page_with_curl: If you are using pynapple, please cite the following paper


New release :fire:

pynapple >= 0.8.2

The objects IntervalSet, TsdFrame and TsGroup inherits a new metadata class. It is now possible to add labels for each interval of an IntervalSet, each column of a TsdFrame and each unit of a TsGroup.

See the documentation for more details

pynapple >= 0.7

Pynapple now implements signal processing. For example, to filter a 1250 Hz sampled time series between 10 Hz and 20 Hz:

nap.apply_bandpass_filter(signal, (10, 20), fs=1250)

New functions includes power spectral density and Morlet wavelet decomposition. See the documentation for more details.

pynapple >= 0.6

Starting with 0.6, IntervalSet objects are behaving as immutable numpy ndarray. Before 0.6, you could select an interval within an IntervalSet object with:

new_intervalset = intervalset.loc[[0]] # Selecting first interval

With pynapple>=0.6, the slicing is similar to numpy and it returns an IntervalSet

new_intervalset = intervalset[0]

pynapple >= 0.4

Starting with 0.4, pynapple rely on the numpy array container approach instead of Pandas for the time series. Pynapple builtin functions will remain the same except for functions inherited from Pandas.

This allows for a better handling of returned objects.

Additionaly, it is now possible to define time series objects with more than 2 dimensions with TsdTensor. You can also look at this notebook for a demonstration of numpy compatibilities.

Community

To ask any questions or get support for using pynapple, please consider joining our slack. Please send an email to thepynapple[at]gmail[dot]com to receive an invitation link.

Getting Started

Installation

The best way to install pynapple is with pip inside a new conda environment:

$ conda create --name pynapple pip python=3.8
$ conda activate pynapple
$ pip install pynapple

Note The package uses a pyproject.toml file for installation and dependencies management.

Running pip install pynapple will install all the dependencies, including:

  • pandas
  • numpy
  • scipy
  • numba
  • pynwb 2.0
  • tabulate
  • h5py

For development, see the contributor guide for steps to install from source code.

Basic Usage

After installation, you can now import the package:

$ python
>>> import pynapple as nap

You'll find an example of the package below. Click here to download the example dataset. The folder includes a NWB file containing the data.

import matplotlib.pyplot as plt
import numpy as np

import pynapple as nap

# LOADING DATA FROM NWB
data = nap.load_file("A2929-200711.nwb")

spikes = data["units"]
head_direction = data["ry"]
wake_ep = data["position_time_support"]

# COMPUTING TUNING CURVES
tuning_curves = nap.compute_1d_tuning_curves(
    spikes, head_direction, 120, ep=wake_ep, minmax=(0, 2 * np.pi)
)


# PLOT
plt.figure()
for i in spikes:
    plt.subplot(3, 5, i + 1, projection="polar")
    plt.plot(tuning_curves[i])
    plt.xticks([0, np.pi / 2, np.pi, 3 * np.pi / 2])

plt.show()

Shown below, the final figure from the example code displays the firing rate of 15 neurons as a function of the direction of the head of the animal in the horizontal plane.

Credits

Special thanks to Francesco P. Battaglia (https://github.com/fpbattaglia) for the development of the original TSToolbox (https://github.com/PeyracheLab/TStoolbox) and neuroseries (https://github.com/NeuroNetMem/neuroseries) packages, the latter constituting the core of pynapple.

This package was developped by Guillaume Viejo (https://github.com/gviejo) and other members of the Peyrache Lab.

Contributing

We welcome contributions, including documentation improvements. For more information, see the contributor guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynapple-0.9.2.tar.gz (89.0 MB view details)

Uploaded Source

Built Distribution

pynapple-0.9.2-py3-none-any.whl (127.9 kB view details)

Uploaded Python 3

File details

Details for the file pynapple-0.9.2.tar.gz.

File metadata

  • Download URL: pynapple-0.9.2.tar.gz
  • Upload date:
  • Size: 89.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pynapple-0.9.2.tar.gz
Algorithm Hash digest
SHA256 b7236490d6304d7c01fb1c2dc98777d1bed14bf765bf54ca15d89fef1482f362
MD5 94102b3eb4859be87064aa9360516363
BLAKE2b-256 81ae21905035355b0296700e1bb8d9802aeb26c93653dcb166ff644785cd8e5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pynapple-0.9.2.tar.gz:

Publisher: deploy.yml on pynapple-org/pynapple

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pynapple-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: pynapple-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 127.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pynapple-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f44e86607edf8d015e62481ccef80bf90d3c2f9ab85de7f1d2417590dd1a584c
MD5 dbd473f37ae934640a7e476b6ce5b1f0
BLAKE2b-256 e0d03f70a57cb8ea1e522d4134f392768b2c70caf15169eaee6d7c6d8497d3f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for pynapple-0.9.2-py3-none-any.whl:

Publisher: deploy.yml on pynapple-org/pynapple

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page