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

Uploaded Source

Built Distribution

neuroconv-0.4.11-py3-none-any.whl (259.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.4.11.tar.gz
  • Upload date:
  • Size: 189.6 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.11.tar.gz
Algorithm Hash digest
SHA256 dc03394f17ae2f104c667caeb0b7bf68d5c48942cbce73e78fca3cb8e5471f79
MD5 e353e6b81ea96184b0c134ffea9201d6
BLAKE2b-256 0f6c1becea698d42d4103859bd432e2ba2a49a77299f198d1435ad348dcbe4b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuroconv-0.4.11-py3-none-any.whl
  • Upload date:
  • Size: 259.1 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1149133a17c53dc4c199629818b62cf02471239d229322fce2c68851e437a806
MD5 404821e1507e648c48307b53919dd1da
BLAKE2b-256 49d33d70561a81dd251b95caca1c854e00653057da06a8bc559cbb386757a79a

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