Skip to main content

Analysis of electrophysiology data

Project description


Tools for the analysis of electrophysiological data collected with the Axona or openephys recording systems.


ephysiopy requires python3.6 or greater. The easiest way to install is using pip:

python3 -m pip install ephysiopy


pip3 install ephysiopy

Or similar.

I haven’t yet tried this in a conda like environment but a quick google shows it should be pretty easy.

Code Example

Neuropixels / openephys tetrode recordings

For openephys-type analysis there are two main entry classes depending on whether you are doing Neuropixels or tetrode-based analysis. Both classes inherit from the same parent class (OpenEphysBase) and so share a high degree of overlap in what they can do.

>>> from ephysiopy.openephys2py.OEKiloPhy import OpenEphysNPX
>>> npx = OpenEphysNPX("/path/to/top_level")

The “/path/to/top_level” bit here means that if your directory hierarchy looks like this:

├── settings.xml
├── 2020-03-20_12-40-15
|    └── experiment1
|        └── recording1
|            ├── structure.oebin
|            ├── sync_messages.txt
|            ├── continuous
|            |   └── Neuropix-PXI-107.0
|            |       └── continuous.dat
|            └── events

Then OpenEphysNPX should be instantiated as follows:

>>> npx = OpenEphysNPX("2020-03-20_12-40-15")

When you load the data the directory structure is iterated over to find files such as sync_messages.txt and settings.xml and so on. The data is loaded by calling the load method:

>>> npx.load()

The same principles apply to the OpenEphysNWB class - as the name suggests this is for use with data recorded in the .nwb format

When data is recorded using the PosTracker plugin for openephys, the position data recorded using that plugin is also loaded, which means plots of position can be produced:

>>> npx.plotPos()

For ratemaps and so on you call plotMaps() which can take several arguments to make maps of different types. See the documentation for the base class for details (OpenEphysBase)

Axona tetrode recordings

The main entry class for Axona related analysis is “Trial” contained in ephysiopy.dacq2py.dacq2py_util i.e.

>>> from ephysiopy.dacq2py.dacq2py_util import Trial
>>> T = Trial("/path/to/dataset/mytrial")

The “usual” Axona dataset includes the following files:

  • mytrial.set
  • mytrial.1
  • mytrial.2
  • mytrial.3
  • mytrial.4
  • mytrial.pos
  • mytrial.eeg

Note that you shouldn’t specify a suffix when constructing the filename in the code example above.

You can now start analysing your data! i.e.

>>> T.plotEEGPower()
>>> T.plotMap(tetrode=1, cluster=4)


Analysis using Axona’s Tint cluster cutting program or phy/ phy2 (openephys) is great but limited. This extends that functionality.

Optional packages include:

Download the files and extract to a folder and make sure it’s on your Python path NB this is limited to data recorded using Axona as it has now been superceded by tools such as KiloSort/ KiloSort2 etc.


Robin Hayman.

Project details

Release history Release notifications | RSS feed

Download files

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

Files for ephysiopy, version 1.7.35
Filename, size File type Python version Upload date Hashes
Filename, size ephysiopy-1.7.35-py3-none-any.whl (212.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ephysiopy-1.7.35.tar.gz (125.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page