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.10.1.tar.gz (686.6 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.1-py3-none-any.whl (861.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.10.1.tar.gz
  • Upload date:
  • Size: 686.6 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.1.tar.gz
Algorithm Hash digest
SHA256 d263b71aca08c37611d89c45a0d7b6751416b83f06141bfac34e57f30d763737
MD5 9e5e495fc122bb36f536726b505523c4
BLAKE2b-256 d3527959b946fe2db550dbfbaf4477ffdd5f49a2fddc884383286229f8957440

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: neuroconv-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 861.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8b70132bbe77d84bc94cdf6fa8fa164250d470d4bbc93b93ec1c6a0d22d6d5d
MD5 2a29fe0b052bb44504a827c169fa29b4
BLAKE2b-256 faa2df76b78a64f291da54767a33b87aefc8f33dfff6b2ba3f2a5a8921131126

See more details on using hashes here.

Provenance

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

This release

0.10.1 This release

2 files

0.10.0

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

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