Metadata-Version: 2.5
Name: ndx-structured-behavior
Version: 0.2.0
Summary: An NWB extension for storing structured behavior programs and data, such as from BAABL/BEADL
Project-URL: Homepage, https://github.com/rly/ndx-structured-behavior
Project-URL: Bug Tracker, https://github.com/rly/ndx-structured-behavior/issues
Project-URL: Changelog, https://github.com/rly/ndx-structured-behavior/blob/main/CHANGELOG.md
Author-email: Ryan Ly <rly@lbl.gov>, Matthew Avaylon <mavaylon@lbl.gov>, Oliver Ruebel <oruebel@lbl.gov>, Michael Wulf <michael.wulf@wustl.edu>
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Keywords: NWB,NeurodataWithoutBorders,ndx-extension,nwb-extension
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
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
Requires-Python: >=3.10
Requires-Dist: hdmf>=6.2.0
Requires-Dist: pynwb>=4.1.0
Requires-Dist: scipy>=1.14.1
Description-Content-Type: text/markdown

# ndx-structured-behavior Extension for NWB

[![PyPI version](https://badge.fury.io/py/ndx-structured-behavior.svg)](https://badge.fury.io/py/ndx-structured-behavior)

> **Version 0.2.0 is not stable and is subject to major breaking changes.**
> NWBEP001, developed as the [ndx-events](https://github.com/rly/ndx-events) extension, has been merged
> into the core NWB schema (version 2.10.0), which now defines `EventsTable`, `TimestampVectorData`, and
> `DurationVectorData`. This extension is not yet fully integrated with those core types, and completing
> that integration is expected to change the on-disk layout.

An NWB extension for storing structured behavior programs and data, such as from BAABL/BEADL.

The extension *ndx_structured_behavior* defines a collection of interlinked table data structures for
storing behavioral tasks and data. While the extension has been designed with BEADL in
mind, the data structures are general and are intended to be useful even without BEADL.
For additional information about BEADL, please visit [https://beadl.org/](https://beadl.org/).

The *ndx-structured-behavior* data model:

![ndx-structured-behavior schema](https://raw.githubusercontent.com/rly/ndx-structured-behavior/main/docs/tutorials/beadl_overview.png "ndx-structured-behavior schema")

## Installation

```bash
pip install ndx-structured-behavior
```

## Usage

See [example.py](https://github.com/rly/ndx-structured-behavior/blob/main/src/pynwb/tests/example.py) for an example of how to use this extension.

---
This extension was created using [ndx-template](https://github.com/nwb-extensions/ndx-template).
