| Name | neuroconv JSON |
| Version |
0.8.2
JSON |
| download |
| home_page | None |
| Summary | Convert data from proprietary formats to NWB format. |
| upload_time | 2025-10-17 22:17:42 |
| maintainer | None |
| docs_url | None |
| author | Cody Baker, Szonja Weigl, Heberto Mayorquin, Paul Adkisson, Luiz Tauffer, Alessandra Trapani |
| requires_python | >=3.10 |
| license | BSD 3-Clause License
Copyright (c) 2019, Neurodata Without Borders
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| keywords |
nwb
neurodatawithoutborders
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://badge.fury.io/py/neuroconv.svg)
[](https://codecov.io/github/catalystneuro/neuroconv?branch=main)
[](https://neuroconv.readthedocs.io/en/main/)
[](https://pypi.python.org/pypi/neuroconv)
[](https://github.com/python/black)
[](https://github.com/catalystneuro/neuroconv/license.txt)
[](https://doi.org/10.5281/zenodo.11492047)
<p align="center">
<img src="https://raw.githubusercontent.com/catalystneuro/neuroconv/main/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
We always recommend installing and running Python packages in a clean environment. One way to do this is via [conda environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment):
```shell
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:
```shell
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:
```shell
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
```shell
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](https://www.dandiarchive.org/)).
You can read more about these options in the main [installation guide](https://neuroconv.readthedocs.io/en/main/user_guide/datainterfaces.html#installation).
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "neuroconv",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "nwb, NeurodataWithoutBorders",
"author": "Cody Baker, Szonja Weigl, Heberto Mayorquin, Paul Adkisson, Luiz Tauffer, Alessandra Trapani",
"author_email": "Ben Dichter <ben.dichter@catalystneuro.com>",
"download_url": "https://files.pythonhosted.org/packages/c6/bd/110757d4d8b3cfd939c5f85b96b3ee7f0f9487102f3b11268cc6df72df58/neuroconv-0.8.2.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/neuroconv.svg)\n\n\n[](https://codecov.io/github/catalystneuro/neuroconv?branch=main)\n[](https://neuroconv.readthedocs.io/en/main/)\n[](https://pypi.python.org/pypi/neuroconv)\n[](https://github.com/python/black)\n[](https://github.com/catalystneuro/neuroconv/license.txt)\n[](https://doi.org/10.5281/zenodo.11492047)\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/catalystneuro/neuroconv/main/docs/img/neuroconv_logo.png\" width=\"250\" alt=\"NeuroConv logo\"/>\n <h3 align=\"center\">Automatically convert neurophysiology data to NWB</h3>\n</p>\n\n<p align=\"center\">\n <a href=\"https://neuroconv.readthedocs.io/\"><strong>Explore our documentation \u00bb</strong></a>\n</p>\n\n\n<!-- TABLE OF CONTENTS -->\n\n## Table of Contents\n\n- [About](#about)\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [License](#license)\n\n## About\n\nNeuroConv is a Python package for converting neurophysiology data in a variety of proprietary formats to the [Neurodata Without Borders (NWB)](http://nwb.org) standard.\n\nFeatures:\n\n* Reads data from 40 popular neurophysiology data formats and writes to NWB using best practices.\n* Extracts relevant metadata from each format.\n* Handles large data volume by reading datasets piece-wise.\n* Minimizes the size of the NWB files by automatically applying chunking and lossless compression.\n* Supports ensembles of multiple data streams, and supports common methods for temporal alignment of streams.\n\n## Installation\nWe always recommend installing and running Python packages in a clean environment. One way to do this is via [conda environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment):\n\n```shell\nconda create --name <give the environment a name> --python <choose a version of Python to use>\nconda activate <environment name>\n```\n\nTo install the latest stable release of **neuroconv** though PyPI, run:\n\n```shell\npip install neuroconv\n```\n\nTo install the current unreleased `main` branch (requires `git` to be installed in your environment, such was via `conda install git`), run:\n\n```shell\npip install git+https://github.com/catalystneuro/neuroconv.git@main\n```\n\nNeuroConv also supports a variety of extra dependencies that can be specified inside square brackets, such as\n\n```shell\npip install \"neuroconv[openephys, dandi]\"\n```\n\nwhich 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](https://www.dandiarchive.org/)).\n\nYou can read more about these options in the main [installation guide](https://neuroconv.readthedocs.io/en/main/user_guide/datainterfaces.html#installation).\n\n\n## Documentation\nSee our [ReadTheDocs page](https://neuroconv.readthedocs.io/en/main/) for full documentation, including a gallery of all supported formats.\n\n## License\nNeuroConv is distributed under the BSD3 License. See [LICENSE](https://github.com/catalystneuro/neuroconv/blob/main/license.txt) for more information.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2019, Neurodata Without Borders\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n ",
"summary": "Convert data from proprietary formats to NWB format.",
"version": "0.8.2",
"project_urls": {
"Changelog": "https://github.com/catalystneuro/neuroconv/blob/main/CHANGELOG.md",
"Documentation": "https://neuroconv.readthedocs.io/",
"Homepage": "https://github.com/catalystneuro/neuroconv"
},
"split_keywords": [
"nwb",
" neurodatawithoutborders"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2ed0ed0e9ad6e657a7a14c08278290a044a6c079a6a8f30fb533722790ad8105",
"md5": "a7cc656e44c0bd602984fa466741a8ac",
"sha256": "d490d5c0dd627d69a2ae33a14113bbfadbe4942aa0a7c0ff99028c3603822f1c"
},
"downloads": -1,
"filename": "neuroconv-0.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7cc656e44c0bd602984fa466741a8ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 386518,
"upload_time": "2025-10-17T22:17:40",
"upload_time_iso_8601": "2025-10-17T22:17:40.546945Z",
"url": "https://files.pythonhosted.org/packages/2e/d0/ed0e9ad6e657a7a14c08278290a044a6c079a6a8f30fb533722790ad8105/neuroconv-0.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c6bd110757d4d8b3cfd939c5f85b96b3ee7f0f9487102f3b11268cc6df72df58",
"md5": "d672487bf4072115c56feef2b9dcc8bf",
"sha256": "702b308f4c4bf5e9181dc2c5ee25bd7415aa054a83c8d49d32a5522ccda7b11c"
},
"downloads": -1,
"filename": "neuroconv-0.8.2.tar.gz",
"has_sig": false,
"md5_digest": "d672487bf4072115c56feef2b9dcc8bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 292728,
"upload_time": "2025-10-17T22:17:42",
"upload_time_iso_8601": "2025-10-17T22:17:42.872189Z",
"url": "https://files.pythonhosted.org/packages/c6/bd/110757d4d8b3cfd939c5f85b96b3ee7f0f9487102f3b11268cc6df72df58/neuroconv-0.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-17 22:17:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "catalystneuro",
"github_project": "neuroconv",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neuroconv"
}
