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

Uploaded Source

Built Distribution

neuroconv-0.6.1-py3-none-any.whl (285.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.6.1.tar.gz
Algorithm Hash digest
SHA256 c6a9574aeb904afa5681060df52810cb26677a154d242c2112436fbae11aa5d4
MD5 0637073a1e1ad9552c37a2ef7ae50cf9
BLAKE2b-256 915ea72fb4970b25772844e521a1738f1bfb8a1d983b6b6f98f3eacd60d0da74

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neuroconv-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e93a6624497334454fb7d4717a56c90299429758065dcb4b8d12dee98027c7a6
MD5 106eaa1a792c061bd970e8b343874ed9
BLAKE2b-256 0ca36bf08b8d7c7a24cf25598d54912c122d86055cf4218698ca956eaab80a96

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