open-earable-python 0.0.1__tar.gz

open_earable_python-0.0.1/.github/workflows/publish-pypi.yml

@@ -0,0 +1,56 @@
+name: Publish to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.*"
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build twine
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Check distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/open-earable-python
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

open_earable_python-0.0.1/.gitignore

@@ -0,0 +1,382 @@
+# Created by https://www.toptal.com/developers/gitignore/api/windows,macos,linux,visualstudiocode,pycharm,python
+# Edit at https://www.toptal.com/developers/gitignore?templates=windows,macos,linux,visualstudiocode,pycharm,python
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/windows,macos,linux,visualstudiocode,pycharm,python

open_earable_python-0.0.1/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.1
+
+* Initial release of the Open Earable Python SDK.
+* parse Open Earable data files

open_earable_python-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 OpenEarable
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

open_earable_python-0.0.1/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: open-earable-python
+Version: 0.0.1
+Summary: 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
+Keywords: openearable,earable,sensors,imu,ppg,audio,wearables,.oe
+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
+
+A Python toolkit for parsing and analyzing multi-sensor recordings from an OpenEarable device. The library provides pandas-friendly accessors for IMU, barometer, PPG, bone accelerometer, optical temperature, and microphone data, along with audio utilities.
+
+## Features
+- Load `.oe` recordings into a single time-aligned pandas DataFrame.
+- Convenient attribute and key-based accessors for grouped sensors and individual channels.
+- Play or export microphone audio directly from notebooks.
+- Export combined sensor data to CSV for downstream analysis.
+
+## Installation
+The package targets Python 3.9+.
+
+Once published to PyPI:
+
+```bash
+pip install open-earable-python
+```
+
+From source (for 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 .
+```
+
+## Quickstart
+Load a recording and explore the combined DataFrame:
+
+```python
+from open_earable_python import SensorDataset
+
+# Load a single .oe file
+recording = SensorDataset("my_recording.oe")
+
+# Time-indexed dataframe containing all available sensors
+full_df = recording.get_dataframe()
+print(full_df.head())
+
+# Export to CSV
+recording.save_csv("my_recording.csv")
+```
+
+### Sensor access patterns
+Each sensor has an accessor exposing both grouped views and individual channels using attribute or key syntax. For IMU data:
+
+```python
+imu = recording.imu
+
+# Full IMU dataframe (original column names retained)
+imu.df          # or imu.to_dataframe()
+imu["acc.x"]   # Column-style access
+
+# Accelerometer
+imu.acc         # Accelerometer dataframe
+imu.acc["x"]   # Accelerometer X channel
+imu.acc["y"]
+imu.acc["z"]
+
+# Gyroscope
+imu.gyro        # Gyroscope dataframe
+imu.gyro["x"]
+imu.gyro["y"]
+imu.gyro["z"]
+
+# Magnetometer
+imu.mag          # Magnetometer dataframe
+imu.mag["x"]
+imu.mag["y"]
+imu.mag["z"]
+```
+
+PPG channels follow the same pattern:
+
+```python
+ppg = recording.ppg
+ppg.df           # Full PPG dataframe
+ppg["ppg.red"]  # Column-style access
+ppg["red"]      # Channel shortcut
+ppg.ir
+ppg.green
+ppg.ambient
+```
+
+### Working with multiple recordings
+Load several files at once and iterate over them:
+
+```python
+from open_earable_python.dataset import load_recordings
+
+paths = ["session1.oe", "session2.oe"]
+recordings = load_recordings(paths)
+
+# Access a specific recording
+first = recordings[0]
+print(first.list_sensors())
+```
+
+### Audio utilities
+- `play_audio(sampling_rate=48000)`: play stereo microphone data in a Jupyter environment.
+- `save_audio(path, sampling_rate=48000)`: export microphone audio to WAV.

open_earable_python-0.0.1/README.md

@@ -0,0 +1,104 @@
+# Open Earable Python
+
+A Python toolkit for parsing and analyzing multi-sensor recordings from an OpenEarable device. The library provides pandas-friendly accessors for IMU, barometer, PPG, bone accelerometer, optical temperature, and microphone data, along with audio utilities.
+
+## Features
+- Load `.oe` recordings into a single time-aligned pandas DataFrame.
+- Convenient attribute and key-based accessors for grouped sensors and individual channels.
+- Play or export microphone audio directly from notebooks.
+- Export combined sensor data to CSV for downstream analysis.
+
+## Installation
+The package targets Python 3.9+.
+
+Once published to PyPI:
+
+```bash
+pip install open-earable-python
+```
+
+From source (for 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 .
+```
+
+## Quickstart
+Load a recording and explore the combined DataFrame:
+
+```python
+from open_earable_python import SensorDataset
+
+# Load a single .oe file
+recording = SensorDataset("my_recording.oe")
+
+# Time-indexed dataframe containing all available sensors
+full_df = recording.get_dataframe()
+print(full_df.head())
+
+# Export to CSV
+recording.save_csv("my_recording.csv")
+```
+
+### Sensor access patterns
+Each sensor has an accessor exposing both grouped views and individual channels using attribute or key syntax. For IMU data:
+
+```python
+imu = recording.imu
+
+# Full IMU dataframe (original column names retained)
+imu.df          # or imu.to_dataframe()
+imu["acc.x"]   # Column-style access
+
+# Accelerometer
+imu.acc         # Accelerometer dataframe
+imu.acc["x"]   # Accelerometer X channel
+imu.acc["y"]
+imu.acc["z"]
+
+# Gyroscope
+imu.gyro        # Gyroscope dataframe
+imu.gyro["x"]
+imu.gyro["y"]
+imu.gyro["z"]
+
+# Magnetometer
+imu.mag          # Magnetometer dataframe
+imu.mag["x"]
+imu.mag["y"]
+imu.mag["z"]
+```
+
+PPG channels follow the same pattern:
+
+```python
+ppg = recording.ppg
+ppg.df           # Full PPG dataframe
+ppg["ppg.red"]  # Column-style access
+ppg["red"]      # Channel shortcut
+ppg.ir
+ppg.green
+ppg.ambient
+```
+
+### Working with multiple recordings
+Load several files at once and iterate over them:
+
+```python
+from open_earable_python.dataset import load_recordings
+
+paths = ["session1.oe", "session2.oe"]
+recordings = load_recordings(paths)
+
+# Access a specific recording
+first = recordings[0]
+print(first.list_sensors())
+```
+
+### Audio utilities
+- `play_audio(sampling_rate=48000)`: play stereo microphone data in a Jupyter environment.
+- `save_audio(path, sampling_rate=48000)`: export microphone audio to WAV.