Metadata-Version: 2.4
Name: nwb2bids
Version: 0.12.0
Summary: Reorganize NWB files into a BIDS directory layout.
Project-URL: Repository, https://github.com/con/nwb2bids/
Project-URL: Issues, https://github.com/con/nwb2bids/issues
Project-URL: Changelog, https://github.com/con/nwb2bids/blob/main/CHANGELOG.md
Author-email: Cody Baker <cody.c.baker.phd@gmail.com>
License: MIT License
        
        Copyright (c) 2025 nwb2bids
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.txt
Keywords: BIDS,Brain Imaging Data Structure,DANDI Archive,NWB,NeurodataWithoutBorders,data organization,data standards,neurodata,neuroscience
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.10
Requires-Dist: pandas
Requires-Dist: pydantic
Requires-Dist: pynwb
Requires-Dist: rich-click
Requires-Dist: ruamel-yaml~=0.18.15
Requires-Dist: typing-extensions
Provides-Extra: all
Requires-Dist: dandi; extra == 'all'
Requires-Dist: remfile; extra == 'all'
Provides-Extra: dandi
Requires-Dist: dandi; extra == 'dandi'
Requires-Dist: remfile; extra == 'dandi'
Description-Content-Type: text/markdown

<div align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/con/nwb2bids/main/docs/assets/nwb2bids-color-dark.svg">
    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/con/nwb2bids/main/docs/assets/nwb2bids-color.svg">
    <img alt="nwb2bids logo" src="https://raw.githubusercontent.com/con/nwb2bids/main/docs/assets/nwb2bids-color.svg" width="200">
  </picture>

  <h1 align="center">nwb2bids</h1>
  <p align="center">
    <a href="https://pypi.org/project/nwb2bids/"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/nwb2bids.svg"></a>
    <a href="https://codecov.io/github/con/nwb2bids?branch=main"><img alt="codecov" src="https://codecov.io/github/con/nwb2bids/coverage.svg?branch=main"></a>
    <a href="https://nwb2bids.readthedocs.io/"><img alt="Documentation Status" src="https://readthedocs.org/projects/nwb2bids/badge/?version=latest"></a>
    <a href="https://github.com/con/nwb2bids/actions/workflows/daily_tests.yml/badge.svg"><img alt="Daily tests" src="https://github.com/con/nwb2bids/actions/workflows/daily_tests.yml/badge.svg"></a>
    <a href="https://github.com/con/nwb2bids/actions/workflows/daily_remote_tests.yml/badge.svg"><img alt="Daily tests (remote)" src="https://github.com/con/nwb2bids/actions/workflows/daily_remote_tests.yml/badge.svg"></a>
  </p>
  <p align="center">
    <a href="https://pypi.org/project/nwb2bids/"><img alt="PyPI latest release version" src="https://badge.fury.io/py/nwb2bids.svg?id=py&kill_cache=1"></a>
    <a href="https://github.com/con/nwb2bids/blob/main/LICENSE.txt"><img alt="License: BSD-3" src="https://img.shields.io/pypi/l/nwb2bids.svg"></a>
    <a href="https://zenodo.org/badge/latestdoi/765478037"><img alt="DOI" src="https://img.shields.io/github/v/release/con/nwb2bids?label=DOI&color=blue"></a>
  </p>
  <p align="center">
    <a href="https://github.com/psf/black"><img alt="Python code style: Black" src="https://img.shields.io/badge/python_code_style-black-000000.svg"></a>
    <a href="https://github.com/astral-sh/ruff"><img alt="Python code style: Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
  </p>
</div>

**nwb2bids** reorganizes [NWB](https://www.nwb.org/) (Neurodata Without Borders) files into a [BIDS](https://bids.neuroimaging.io/) (Brain Imaging Data Structure) directory layout, making your neurophysiology data more accessible and shareable.



## Features

- **Automatic conversion**: Renames NWB files and directories to conform to BIDS conventions
- **Metadata extraction**: Populates BIDS sidecar TSV & JSON files from NWB metadata
- **BEP032 support**: Currently supports micro-electrode electrophysiology (extracellular `ecephys` and intracellular `icephys`) and associated behavioral events per [BEP032](https://github.com/bids-standard/bids-specification/pull/1705)



## Installation

Install the latest stable release using `pip` or `conda`:

```bash
# Using pip
pip install nwb2bids

# Using conda
conda install -c conda-forge nwb2bids
```



## Quick Start

### Command Line Interface

Convert NWB files to BIDS from the command line:

```bash
# Convert files from a directory
nwb2bids convert path/to/nwb/files/

# Specify output directory
nwb2bids convert path/to/nwb/files/ --bids-directory path/to/bids/output/

# Convert multiple sources
nwb2bids convert path/to/directory/ single_file.nwb another_file.nwb
```



## Documentation

For comprehensive information, please visit our full documentation:

📖 **[nwb2bids.readthedocs.io](https://nwb2bids.readthedocs.io/)**

The documentation includes:
- [User Guide](https://nwb2bids.readthedocs.io/en/latest/user_guide.html) - Detailed usage instructions and advanced features
- [Tutorials](https://nwb2bids.readthedocs.io/en/latest/tutorials.html) - Step-by-step examples
- [API Reference](https://nwb2bids.readthedocs.io/en/latest/api/index.html) - Complete function and class documentation
- [Developer Guide](https://nwb2bids.readthedocs.io/en/latest/developer_guide.html) - Contributing guidelines



## Use Cases

**nwb2bids** was developed to support the [DANDI Archive](https://dandiarchive.org/) project, enabling researchers to convert neurophysiology datasets from NWB to BIDS format.

### Track development with BIDS-Dandisets

The [bids-dandisets organization](https://github.com/bids-dandisets/) hosts BIDS-formatted versions of datasets from DANDI Archive. You can:

- Browse converted datasets at [github.com/bids-dandisets](https://github.com/bids-dandisets/)
- Track conversion progress via the [dashboard](https://github.com/bids-dandisets/dashboard?tab=readme-ov-file)
- Access datasets efficiently using [DataLad](https://www.datalad.org/) for version-controlled data management

## Contributing

We welcome contributions! Please see our [Developer Guide](https://nwb2bids.readthedocs.io/en/latest/developer_guide.html) for details on how to contribute.
