Skip to main content

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.9.0.tar.gz (315.9 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.9.0-py3-none-any.whl (415.5 kB view details)

Uploaded Python 3

File details

Details for the file neuroconv-0.9.0.tar.gz.

File metadata

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

File hashes

Hashes for neuroconv-0.9.0.tar.gz
Algorithm Hash digest
SHA256 64e1f85f0068f883d7d08a54757e0a7a50d73a48a2d8e38e3f52fbca98b595cf
MD5 c211fc32a09464db869c53d49c1fba8e
BLAKE2b-256 59bd1ef7bcfca3d866c081ffca2e8317ede4cfbf9988e067e3f0e306639f58a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for neuroconv-0.9.0.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.9.0-py3-none-any.whl.

File metadata

  • Download URL: neuroconv-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 415.5 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.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f396c6fbb06e5587220566c82c8839304c7dd6f549bbdf936904a9c355be4de
MD5 2644bf09e50a4812b00b1180a6525c84
BLAKE2b-256 8b0be19e1950eebc7a1f7aeeae68ee2e5abeeb9405c054f01c1dd53a31dbe484

See more details on using hashes here.

Provenance

The following attestation bundles were made for neuroconv-0.9.0-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.1

2 files

0.10.0

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

This release

0.9.0 This release

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

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page