py

Welcome to the EmotiBit Python Library

Setup Python virtual environment

1. cd into the py directory under the root directory
2. Run python -m venv emotibit-env to create a virtual environment named emotibit-env. Note that some requirements have a minimum python version. We recommend using python 3.12+. Environment creation and requirements were tested using python 3.12.12.
3. Activate the virtual environment by running
   • Windows: .\venv\Scripts\activate
   • macOS/Linux: source emotibit-env/bin/activate
4. The terminal should now start with (emotibit-env) followed by path to current working directory (ex. (emotibit-env) C:\Users\username\Documents\...)
5. Install required packages by running pip install -r requirements.txt
6. Install the emotibit package by running pip install -e . while in the py directory

Checkout the examples folder to start working with the recorded data.

Note: Before running any example, make sure that emotibit-env has been activated so that the emotibit package and other dependencies can be found

Python Data Viewer

The Python Data viewer is an interactive tool designed to visualize the data stored on the SD-Card from the EmotiBit.

• Refer to py/emotibit/examples/dataviewer_example/README.md for detailed instructions on how to use Data Viewer