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.6.4.tar.gz (223.7 kB view details)

Uploaded Source

Built Distribution

neuroconv-0.6.4-py3-none-any.whl (290.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.6.4.tar.gz
Algorithm Hash digest
SHA256 f5bccde933988bc60f599423fd3db5cd7eeb5856cc6c9e5922f1c1f7e4d50620
MD5 3b6a57b345c6167b9a52b5762483abae
BLAKE2b-256 a54e61a29959ab7836ee562c2f9b247f23690b73247aab830c6ae72c7a8d9747

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 49bf50d551089eb49ae51b136799d770cdee7992f321856ef67971ce440756bd
MD5 8f1ac04d5e7f6b10047425dbcddb9d1f
BLAKE2b-256 0d3cc708775f0b67cb2c6768ccec45c6a43f8ab673bfe4bb5edb9cda89c74fbc

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