Metadata-Version: 2.4
Name: open-earable-python
Version: 0.0.3
Summary: DEPRECATED: renamed to open-wearable. Reader and utilities for multi-sensor OpenEarable recordings.
Author-email: "Karlsruhe Institut of Technology (KIT)" <open-earable@lists.kit.edu>
License-Expression: MIT
Project-URL: Source, https://github.com/OpenEarable/open-earable-python
Project-URL: Issues, https://github.com/OpenEarable/open-earable-python/issues
Project-URL: Migration Guide, https://github.com/OpenEarable/open-earable-python/blob/main/docs/migration-to-open-wearable.md
Project-URL: New Package (PyPI), https://pypi.org/project/open-wearable/
Keywords: openearable,open-wearable,earable,sensors,imu,ppg,audio,wearables,.oe,deprecated
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: ipython
Requires-Dist: scipy
Dynamic: license-file

# Open Earable Python

> [!WARNING]
> `open-earable-python` is deprecated and has been renamed to **`open-wearable`**.
> Migrate now:
> - Install: `pip install open-wearable`
> - Update imports: `from open_earable_python import ...` -> `from open_wearable import ...`
> - Deprecation timeline: this package receives only critical fixes until **December 31, 2026**.
> - Migration guide: [docs/migration-to-open-wearable.md](docs/migration-to-open-wearable.md)

Python toolkit for parsing and analyzing multi-sensor OpenEarable recordings.

## Installation

```bash
pip install open-wearable
```

Legacy package (deprecated):

```bash
pip install open-earable-python
```

For local development:

```bash
git clone https://github.com/OpenEarable/open-earable-python.git
cd open-earable-python
python -m venv .venv
source .venv/bin/activate
pip install -e .
```

## Quick Example

```python
from open_wearable import SensorDataset

dataset = SensorDataset("recording.oe")

# Combined time-indexed DataFrame of all parsed sensors
df = dataset.get_dataframe()

# Per-sensor views
imu_df = dataset.imu.df
ppg_red = dataset.ppg["ppg.red"]
audio_df = dataset.get_audio_dataframe()
```

## Documentation

- [Documentation index](docs/README.md)
- [Getting started](docs/getting-started.md)
- [Data model and sensor channels](docs/data-model.md)
- [API reference](docs/api-reference.md)
- [Migration to open-wearable](docs/migration-to-open-wearable.md)

## License

MIT. See `LICENSE`.
