An open API service indexing awesome lists of open source software.

https://github.com/neurodatawithoutborders/aqnwb

A C++ API for data acquisition using the NWB Format
https://github.com/neurodatawithoutborders/aqnwb

Last synced: 10 months ago
JSON representation

A C++ API for data acquisition using the NWB Format

Awesome Lists containing this project

README

          

# AqNWB

[![Unit tests](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/tests.yml/badge.svg)](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/tests.yml)
[![Codespell](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/codespell.yml/badge.svg)](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/codespell.yml)
[![Lint](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/lint.yml/badge.svg)](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/lint.yml)
[![Docs build](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/doxygen-gh-pages.yml/badge.svg)](https://github.com/NeurodataWithoutBorders/aqnwb/actions/workflows/doxygen-gh-pages.yml)
[![Coverage](https://codecov.io/github/NeurodataWithoutBorders/aqnwb/coverage.svg?branch=main)](https://app.codecov.io/github/NeurodataWithoutBorders/aqnwb?branch=main)

[![Docs](https://img.shields.io/badge/AqNWB-Docs-8A2BE2?style=flat)](https://nwb.org/aqnwb/)
[![Code Stats](https://img.shields.io/badge/AqNWB-Code%20Statistics-8A2BE2?style=flat)](https://nwb-overview.readthedocs.io/en/latest/nwb-project-analytics/docs/source/code_stat_pages/AqNWB_stats.html)

**AqNWB is currently under active development and should not yet be used in practice.**

AqNWB is a C++ API for acquiring neurophysiological data directly into the NWB (Neurodata Without Borders) format.
Our goal is to provide a lightweight API to integrate with existing acquisition systems.

Please see the [AqNWB Documentation](https://neurodatawithoutborders.github.io/aqnwb/) for
installation instructions and to learn more about AqNWB.

Below is a high-level overview of the project structure and capabilities we are targeting:

![Project Overview](resources/images/aqnwb_objective_500px.png)

## Installation

See the [AqNWB Documentation](https://neurodatawithoutborders.github.io/aqnwb/) for installation and integration instructions.
* [User Installation](https://neurodatawithoutborders.github.io/aqnwb/install_page.html)
* [Developer Installation](https://neurodatawithoutborders.github.io/aqnwb/dev_install_page.html)

## Contributing and Legal

For more information about the license, contributing guidelines, code of conduct
and other relevant documentation for developers please see the
[Developer Documentation](https://neurodatawithoutborders.github.io/aqnwb/devdocs.html).