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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.6.2.tar.gz
  • Upload date:
  • Size: 223.8 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.2.tar.gz
Algorithm Hash digest
SHA256 a13e6a912dab0917e8959d48fdefb13af9ea7b5bb32ff9dd54578640e38d0c56
MD5 63a62a63d532a058f4690683c73807ab
BLAKE2b-256 07969b3a2b6c83a860fda94a271095a79989afa144a36299e8171d95c80eb307

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuroconv-0.6.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0e70ed0d4f5968d3b27207e3e066aebe18d2a8af0dbb5449b5ae03c68ce67b3c
MD5 c541a8621b3e5f7b0b7bceacd744517d
BLAKE2b-256 e9c6e8e193206d9f1066bad7f0336d5c69768bcbb59e4e99ac248cc8c7b8b261

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