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[dandi]

which will then install extra dependencies related to 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.4.9.tar.gz (188.5 kB view details)

Uploaded Source

Built Distribution

neuroconv-0.4.9-py3-none-any.whl (257.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.4.9.tar.gz
Algorithm Hash digest
SHA256 2546f6e051937559c479b2fdccd58a04a949e135b5b3914e9db96919d65d7893
MD5 55c4fc2a9700a01a02d83c45d65a0bf8
BLAKE2b-256 4404204aaeb6e3db5edec8ff1171acf8a60f593cb638425830147f63b7a2fee6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 127836b43bdcb99cc3095fcefecc7b471f9a68a15d601be47e032e1fde6aed9d
MD5 712df52002f137d886bcab8a60b86d36
BLAKE2b-256 efc9d04cd78a62f4919a6114d6c24837ab34d0899820c178edd5201caefd376f

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