Skip to main content

Convert data from proprietary formats to NWB format.

Project description

PyPI version Full 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.8.tar.gz (176.4 kB view details)

Uploaded Source

Built Distribution

neuroconv-0.4.8-py3-none-any.whl (243.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuroconv-0.4.8.tar.gz
  • Upload date:
  • Size: 176.4 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.8.tar.gz
Algorithm Hash digest
SHA256 c59c296dff6d65ee85a0eb2f67963fad11ce0ffaac1c1cb820098a423e964f5d
MD5 7a9d44146280804272ae623021c61006
BLAKE2b-256 cb82ca1291ea414481de3245a11ac708fb3c23b8fb124e5ead2b0d103b16c65b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuroconv-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 243.2 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 02f4f8e3dc7d66aeaae0456a1e77035da95e43faea7660312a8da5857d1ebac3
MD5 6320657669999e26be24b21705dc85d9
BLAKE2b-256 a75ca571ad378a9287835d30067c9e1a402b9ccfb6d51fbd98a7aa60182799cc

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