Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PyPI version Daily Tests Auto-release codecov documentation Python Code Style License doi

NeuroConv logo

Automatically convert neurophysiology data to NWB

Explore our documentation »

Table of Contents

About

NeuroConv is a Python package for converting neurophysiology data in a variety of proprietary formats to the Neurodata Without Borders (NWB) standard.

Features:

  • Reads data from 50 popular neurophysiology data formats and writes to NWB using best practices.
  • Extracts relevant metadata from each format.
  • Handles large data volume by reading datasets piece-wise.
  • Minimizes the size of the NWB files by automatically applying chunking and lossless compression.
  • Supports ensembles of multiple data streams, and supports common methods for temporal alignment of streams.

Installation

We always recommend installing and running Python packages in a clean environment. One way to do this is via conda environments:

conda create --name <give the environment a name> --python <choose a version of Python to use>
conda activate <environment name>

To install the latest stable release of neuroconv though PyPI, run:

pip install neuroconv

To install the current unreleased main branch (requires git to be installed in your environment, such was via conda install git), run:

pip install git+https://github.com/catalystneuro/neuroconv.git@main

NeuroConv also supports a variety of extra dependencies that can be specified inside square brackets, such as

pip install "neuroconv[openephys, dandi]"

which will then install extra dependencies related to reading OpenEphys data as well as the usage of the DANDI CLI (such as automatic upload to the DANDI Archive).

You can read more about these options in the main installation guide.

Documentation

See our ReadTheDocs page for full documentation, including a gallery of all supported formats.

Citing NeuroConv

If you use NeuroConv in your research, please cite our paper:

Mayorquin, H., Baker, C., Adkisson-Floro, P., Weigl, S., Trapani, A., Tauffer, L., Rübel, O., & Dichter, B. (2025). NeuroConv: Streamlining Neurophysiology Data Conversion to the NWB Standard. Proceedings of the 24th Python in Science Conference (SciPy 2025). https://doi.org/10.25080/cehj4257

BibTeX

@inproceedings{mayorquin2025neuroconv,
  title={NeuroConv: Streamlining Neurophysiology Data Conversion to the NWB Standard},
  author={Mayorquin, Heberto and Baker, Cody and Adkisson-Floro, Paul and Weigl, Szonja and Trapani, Alessandra and Tauffer, Luiz and R\"ubel, Oliver and Dichter, Benjamin},
  booktitle={Proceedings of the 24th Python in Science Conference},
  year={2025},
  month={July},
  doi={10.25080/cehj4257}
}

License

NeuroConv is distributed under the BSD3 License. See LICENSE for more information.

Download files

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

Source Distribution

neuroconv-0.10.0rc2.tar.gz (590.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuroconv-0.10.0rc2-py3-none-any.whl (752.3 kB view details)

Uploaded Python 3

File details

Details for the file neuroconv-0.10.0rc2.tar.gz.

File metadata

  • Download URL: neuroconv-0.10.0rc2.tar.gz
  • Upload date:
  • Size: 590.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for neuroconv-0.10.0rc2.tar.gz
Algorithm Hash digest
SHA256 6f6485fb60f373f2cac2be6e0c362642a1d355acbaca210c07d415a6317d94f7
MD5 8279909fc80c8a025f08a90246b9bb3e
BLAKE2b-256 c2415e74dad2e0468804b0b82f933e44f365c8e8ad45720c26976eea9af3d579

See more details on using hashes here.

Provenance

The following attestation bundles were made for neuroconv-0.10.0rc2.tar.gz:

Publisher: auto-publish.yml on catalystneuro/neuroconv

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

File details

Details for the file neuroconv-0.10.0rc2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for neuroconv-0.10.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 6970abcdd8e369480149eb073193ccb067e600c9e49e400b0101c51f597bf3e9
MD5 9646ed740b91727576746055768e0f4a
BLAKE2b-256 ec51459c0e57f33eeed71c9e8fe24682c3e015b7a7fe3822fad1b0e57e746625

See more details on using hashes here.

Provenance

The following attestation bundles were made for neuroconv-0.10.0rc2-py3-none-any.whl:

Publisher: auto-publish.yml on catalystneuro/neuroconv

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

Release history Release notifications | RSS feed

0.10.0

2 files

This release

0.10.0rc2 This release

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.11

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

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