Metadata-Version: 2.4
Name: brainaccess
Version: 4.0.0
Summary: BrainAccess Python API
Project-URL: homepage, https://www.brainaccess.ai/
Project-URL: documentation, https://www.brainaccess.ai/software/brainaccess-sdk/
Author-email: neurotechnology <brainaccess@neurotechnology.com>
License-File: LICENSE.md
Keywords: BCI,ECG,EEG,EMG,EOG,IMU,brainaccess,neuroscience
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Requires-Dist: matplotlib
Requires-Dist: mne>=1.4
Requires-Dist: numpy>=1.21
Requires-Dist: scipy
Description-Content-Type: text/markdown

# BrainAccess Python API

Python API for BrainAccess headsets (HALO, MINI, MIDI, MAXI and EXG8). The package bundles the native
BrainAccess Core library; no separate installation is required.

## Installation

```
pip install brainaccess
```

Requires Python 3.8 or newer, including the free-threaded builds (3.14t and
later). Wheels are available for:

- Linux x86_64 and aarch64 (glibc 2.28 or newer: RHEL/Alma/Rocky 8+, Debian 10+, Ubuntu 18.10+, Raspberry Pi OS 10+, 64-bit),
- macOS 11 or newer (Apple silicon and Intel),
- Windows 10/11 x64.

A Bluetooth Low Energy adapter is required (on Linux the BlueZ service must be running).

## Quick start

```python
from brainaccess import EEGManager
from brainaccess.utils import EEG

eeg = EEG()
with EEGManager() as mgr:
    # cap: 0-based electrode index -> channel name
    eeg.setup(mgr, device_name="BA HALO 001", cap={0: "Fp1", 1: "Fp2", 2: "O1", 3: "O2"})
    eeg.start_acquisition()
    # ... record ...
    eeg.stop_acquisition()
    raw = eeg.get_mne()   # MNE Raw, electrode channels in volts
eeg.close()
```

For fine-grained control (channel configuration, callbacks, impedance mode)
use `brainaccess.core` and `brainaccess.EEGManager` directly.

## What's new in 4.0

4.0.0 contains breaking changes compared with 3.6.1; see the release notes in the documentation.

## Links

- Website: https://www.brainaccess.ai/
- Documentation and API reference: https://www.brainaccess.ai/documentation/python-api/4.0.0/
- Release notes: https://www.brainaccess.ai/documentation/python-api/4.0.0/changelog.html
