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

Uploaded Source

Built Distribution

neuroconv-0.6.3-py3-none-any.whl (287.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.6.3.tar.gz
Algorithm Hash digest
SHA256 a53dab02ae9a1395437efb8fcdaf0dc6e4386c3b1621c6db3879326ad33f2e63
MD5 8a5608352c7345142686594b5020c93a
BLAKE2b-256 ca9316bce1ee8fd8718333471d4879d1820a57498fd7939604cd8e54679c2d12

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bcd1eac175e6570c9c32d4221648029655331e98e2bea84be36803c613e616de
MD5 b42a5e08b230ef5bf1336357674a2a3e
BLAKE2b-256 64e05aa9c408e2a6aaec359f172c42f55fc4d17c9d515fdd9e918d036c64a4c5

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