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

Uploaded Source

Built Distribution

neuroconv-0.6.5-py3-none-any.whl (293.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.6.5.tar.gz
  • Upload date:
  • Size: 223.5 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.5.tar.gz
Algorithm Hash digest
SHA256 62be076b83813563c9e0425b41a36cc8ebad1d36937054180c8cb19822854ebd
MD5 a7d9def5f7c109165ede9e3c5e4b2669
BLAKE2b-256 e147a4dbdef6c6b1a006cdb15f56d09a6a6e72a3e1dec0ea6f0497bf912f46b3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuroconv-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 293.3 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 03413e800e7690ffade054d6bd26e5531385c8e66ff2a0f07fe235c1cc09b8be
MD5 3d276a43ef912feed34e2c1507be0ebe
BLAKE2b-256 a2ed9a483c18f86e05bb1f3a38c2e19462ac3219066e2c96b26bea3201e50b8f

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