Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
## 0.0.2
## 0.1.0

* added access to raw microphone dataframes
* added a dedicated `docs/` documentation set (getting started, data model, API reference)
* updated `README.md` as a concise entry point and linked full docs

## 0.0.1

* Initial release of the Open Earable Python SDK.
* parse Open Earable data files
* Initial release of the Open Wearable Python SDK.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Open Earable Python
# Open Wearable

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

## Installation

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

For local development:
Expand All @@ -21,7 +21,7 @@ pip install -e .
## Quick Example

```python
from open_earable_python import SensorDataset
from open_wearable import SensorDataset

dataset = SensorDataset("recording.oe")

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Open Earable Python Documentation
# Open Wearable Documentation

`open-earable-python` parses `.oe` recordings into pandas DataFrames and exposes convenient accessors for OpenEarable sensor streams.
`open-wearable` parses `.oe` recordings into pandas DataFrames and exposes convenient accessors for OpenEarable sensor streams.

## Contents

Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Package Exports

```python
from open_earable_python import SensorDataset, load_recordings
from open_wearable import SensorDataset, load_recordings
```

## `SensorDataset`
Expand Down Expand Up @@ -102,7 +102,7 @@ load_recordings(file_paths: Sequence[str]) -> List[SensorDataset]

Creates `SensorDataset` objects for existing files only.

## Parser Module (`open_earable_python.parser`)
## Parser Module (`open_wearable.parser`)

Core classes and helpers for decoding binary packets:

Expand All @@ -114,7 +114,7 @@ Core classes and helpers for decoding binary packets:
- `interleaved_mic_to_stereo(samples)`: converts interleaved samples to stereo.
- `mic_packet_to_stereo_frames(packet, sampling_rate)`: timestamp + stereo frame conversion.

## Scheme Module (`open_earable_python.scheme`)
## Scheme Module (`open_wearable.scheme`)

Defines sensor schema primitives:

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
## Installation

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

From source:
Expand All @@ -24,7 +24,7 @@ pip install -e .
## Load a Recording

```python
from open_earable_python import SensorDataset
from open_wearable import SensorDataset

dataset = SensorDataset("my_recording.oe")
```
Expand Down Expand Up @@ -88,7 +88,7 @@ dataset.save_csv("recording.csv")
## Load Multiple Files

```python
from open_earable_python import load_recordings
from open_wearable import load_recordings

recordings = load_recordings(["session1.oe", "session2.oe"])
for rec in recordings:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["setuptools>=80", "setuptools-scm[toml]>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "open-earable-python"
name = "open-wearable"
dynamic = ["version"]
description = "Reader and utilities for multi-sensor OpenEarable recordings."
readme = "README.md"
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

import numpy as np
import pandas as pd
from open_earable_python import parser
import open_earable_python.scheme as scheme
from open_wearable import parser
import open_wearable.scheme as scheme
from IPython.display import Audio, display
from scipy.io.wavfile import write

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import struct
from open_earable_python.scheme import SensorScheme, ParseType
from open_wearable.scheme import SensorScheme, ParseType
import pandas as pd
from typing import BinaryIO, Dict, List, Optional, Tuple, TypedDict, Union
from dataclasses import dataclass, field
Expand Down
File renamed without changes.