Metadata-Version: 2.1
Name: neuroconv
Version: 0.4.3
Summary: Convert data from proprietary formats to NWB format.
Home-page: https://github.com/catalystneuro/neuroconv
Author: Cody Baker, Szonja Weigl, Heberto Mayorquin, Luiz Tauffer, and Ben Dichter.
Author-email: ben.dichter@catalystneuro.com
License: BSD-3-Clause
Keywords: nwb
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: full
Provides-Extra: ophys
Provides-Extra: sima
Provides-Extra: brukertiff
Provides-Extra: scanimage
Provides-Extra: tiff
Provides-Extra: hdf5
Provides-Extra: sbx
Provides-Extra: micromanagertiff
Provides-Extra: suite2p
Provides-Extra: caiman
Provides-Extra: extract
Provides-Extra: cnmfe
Provides-Extra: miniscope
Provides-Extra: ecephys
Provides-Extra: spikeinterface
Provides-Extra: neuralynx
Provides-Extra: mcsraw
Provides-Extra: axona
Provides-Extra: kilosort
Provides-Extra: spikegadgets
Provides-Extra: maxwell
Provides-Extra: spikeglx
Provides-Extra: neuroscope
Provides-Extra: alphaomega
Provides-Extra: biocam
Provides-Extra: plexon
Provides-Extra: spike2
Provides-Extra: phy
Provides-Extra: intan
Provides-Extra: edf
Provides-Extra: mearec
Provides-Extra: openephys
Provides-Extra: tdt
Provides-Extra: cellexplorer
Provides-Extra: blackrock
Provides-Extra: icephys
Provides-Extra: abf
Provides-Extra: audio
Provides-Extra: behavior
Provides-Extra: sleap
Provides-Extra: video
Provides-Extra: fictrac
Provides-Extra: deeplabcut
Provides-Extra: csv
Provides-Extra: excel
Provides-Extra: text
License-File: license.txt

[![PyPI version](https://badge.fury.io/py/neuroconv.svg)](https://badge.fury.io/py/neuroconv.svg)
![Full Tests](https://github.com/catalystneuro/neuroconv/actions/workflows/testing.yml/badge.svg)
![Auto-release](https://github.com/catalystneuro/neuroconv/actions/workflows/auto-publish.yml/badge.svg)
[![codecov](https://codecov.io/github/catalystneuro/neuroconv/coverage.svg?branch=main)](https://codecov.io/github/catalystneuro/neuroconv?branch=main)
[![documentation](https://readthedocs.org/projects/neuroconv/badge/?version=main)](https://neuroconv.readthedocs.io/en/main/)
[![License](https://img.shields.io/pypi/l/neuroconv.svg)](https://github.com/catalystneuro/neuroconv/license.txt)

<p align="center">
  <img src="docs/img/neuroconv_logo.png" width="250" alt="NeuroConv logo"/>
  <h3 align="center">Automatically convert neurophysiology data to NWB</h3>
</p>
<p align="center">
   <a href="https://neuroconv.readthedocs.io/"><strong>Explore our documentation »</strong></a>
</p>


<!-- TABLE OF CONTENTS -->

## Table of Contents

- [About](#about)
- [Installation](#installation)
- [Documentation](#documentation)
- [License](#license)

## About

NeuroConv is a Python package for converting neurophysiology data in a variety of proprietary formats to the [Neurodata Without Borders (NWB)](http://nwb.org) 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
To install the latest stable release of **neuroconv** though PyPI, type:
```shell
pip install neuroconv
```

For more flexibility we recommend installing the latest version directly from GitHub. The following commands create an environment with all the required dependencies and the latest updates:

```shell
git clone https://github.com/catalystneuro/neuroconv
cd neuroconv
conda env create -f make_environment.yml
conda activate neuroconv_environment
```
Note that this will install the package in [editable mode](https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs).

Finally, if you prefer to avoid `conda` altogether, the following commands provide a clean installation within the current environment:
```shell
pip install git+https://github.com/catalystneuro/neuroconv.git@main
```

## Documentation
See our [ReadTheDocs page](https://neuroconv.readthedocs.io/en/main/) for full documentation, including a gallery of all supported formats.

## License
NeuroConv is distributed under the BSD3 License. See [LICENSE](https://github.com/catalystneuro/neuroconv/blob/main/license.txt) for more information.
