Skip to main content

Convert data from proprietary formats to NWB format.

Project description

PyPI version Full Tests Auto-release codecov documentation 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.7.tar.gz (324.0 kB view details)

Uploaded Source

Built Distribution

neuroconv-0.4.7-py3-none-any.whl (243.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.4.7.tar.gz
  • Upload date:
  • Size: 324.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for neuroconv-0.4.7.tar.gz
Algorithm Hash digest
SHA256 2cf91a0780e5a8f107f5febc9518d60292561fb34409e09602dc9ce4211e99ab
MD5 becd42edbd7bdf5332e184b4c2045865
BLAKE2b-256 a3eb182cc478f4e2482358f368b20bf18324c588d483706bd961688d655be67e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuroconv-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 243.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for neuroconv-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d0d97534fdd6503045d0bad01d7533a7a104e8cef5a3876aa09e17548b258835
MD5 04293043c7fbf6554eef84d4d430261f
BLAKE2b-256 c11713c7f3c4a2c0133b3c5806ccdf2dc486f3568afbe0e506213fd8ea190154

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