Skip to main content

EpiBOX, the Python package

A Research Tool to Stimulate Collaboration Within Biosignal Collection

EpiBOX was developed as a way to enable researchers to escalate their data collection process by leveraging the human resources available. By providing a versatile, discreet, user-friendly and open-source system, operated through a mobile application, we hope to provide a collaboration tool for the acquisition of biosignals.

Designed for use with a Raspberry Pi due to its unobtrusive design (but usable with any Linux device), it acts as an autonomous recording unit - allowing for sensor connectivity and data storage. EpiBOX mobile app provides the user interface and the near-real time visualization of the data.

Currently, EpiBOX supports BITalino-based equipments allowing for the recording, storage and visualization of up to 12 channels simmultaneously. Nevertheless, this package can be easily integrated with other sensors, as long as a Python API is provided!

Requirements

  • This Python package is complementary the mobile app EpiBOX (available at EpiBOX);
  • It also requires a Raspberry Pi set up as a wireless access point and MQTT broker in order to ensure communication between the mobile app and the recording unit (RPi itself or another Linux device).

Installation

Use the package manager pip to install epibox.

pip install epibox
or 
pip install --upgrade epibox

Usage

# this will initiate the process - which should be continued by the user interface (EpiBOX app)
python -m epibox

Features

  • Step-by-step interactions to start the acquisition
  • History of acquisition devices
  • Default configurations for optimized interaction
  • Real-time visualization of up-to 12 channels
  • In-acquisition annotations

Additional Resources

Why BITalino:

  • Versatility of sensors & flexibility of wearable form-factors
  • Rapid & cheap prototyping
  • Peer-validated against gold-standards

Why Raspberry Pi:

  • Discreteness
  • Affordability
  • Ease of system replication - through shell script or RPi imager
  • Computational and storage power

Get to know our project @ LinkedIn - PreEpiSeizures

License

MIT

Contact

For any additional information about the mobile app or our project please contact me: anascacais@gmail.com

======= History

0.1.0 (2021-07-08)

  • First release on PyPI.

Metadata

Release files for epibox 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for epibox 3.0.0
File Size Uploaded Provenance
epibox-3.0.0.tar.gz 22.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for epibox 3.0.0
File Interpreter ABI Platform
epibox-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 43.7 kB

Release files / epibox-3.0.0.tar.gz

Download URL epibox-3.0.0.tar.gz
Size 22.2 kB
Tags Source
SHA-256 checksum
How to use checksums
bbc148c3315417f6b55e26dfd53239e1a05d370c4104409dae5e4ee64a4d8b3b
BLAKE2b-256 checksum
How to use checksums
63fa58413d641be88e0b4e260c69d4b19f582105bb6b06f76c9045867ef163aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.19

Release files / epibox-3.0.0-py3-none-any.whl

Download URL epibox-3.0.0-py3-none-any.whl
Size 21.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ee0e929f56b73d71a9c92a2d49fa97145b3d665e29d2faab9c0991703a15307a
BLAKE2b-256 checksum
How to use checksums
fcced0c316313082f5585f1dd0f57f23b7f64afb15da59d86cf7fd3801fe5c2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.19

Security for epibox 3.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page