Skip to main content

Convert data from proprietary formats to NWB format.

Project description

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

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 40 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.

License

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

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

neuroconv-0.5.0.tar.gz (192.8 kB view details)

Uploaded Source

Built Distribution

neuroconv-0.5.0-py3-none-any.whl (262.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.5.0.tar.gz
  • Upload date:
  • Size: 192.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for neuroconv-0.5.0.tar.gz
Algorithm Hash digest
SHA256 46d95a50d157d5dcaa175c49de093adbd0aec225cb2d0aef967d25fda4602cdf
MD5 501b4b6cd90110b75196d1e1e19478cb
BLAKE2b-256 76826e1efe3632b423be5608e266aa656b1b527a96cde7da4c62691c2f274a27

See more details on using hashes here.

File details

Details for the file neuroconv-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: neuroconv-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 262.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for neuroconv-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9285c1cb3601c68f323ed96ff3d1821fb899ca0e4b97328e098d3822d39b273e
MD5 be4f3afc6eb673666edacda344517060
BLAKE2b-256 ce006ce3646c2c2a4f09c128a96798c7d891132c9d648a1bc2e1e31c2966e2a1

See more details on using hashes here.

Supported by

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