# 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](https://github.com/anascacais/epibox_app));
- 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](https://pip.pypa.io/en/stable/) to install epibox.
```bash
pip install epibox
or
pip install --upgrade epibox
```
## Usage
```bash
# 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](https://www.linkedin.com/feed/update/urn:li:activity:6787017108631941120/)
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/anascacais/epibox",
"name": "epibox",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.10,>=3.6",
"maintainer_email": null,
"keywords": "epibox, signal acquisition, Raspberry Pi",
"author": "Ana Sofia Carmo",
"author_email": "anascacais@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/63/fa/58413d641be88e0b4e260c69d4b19f582105bb6b06f76c9045867ef163aa/epibox-3.0.0.tar.gz",
"platform": null,
"description": "# EpiBOX, the Python package\n## A Research Tool to Stimulate Collaboration Within Biosignal Collection\n\nEpiBOX 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.\n\nDesigned 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. \n\nCurrently, 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!\n\n## Requirements\n\n - This Python package is complementary the mobile app EpiBOX (available at [EpiBOX](https://github.com/anascacais/epibox_app));\n - 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).\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install epibox.\n\n```bash\npip install epibox\nor \npip install --upgrade epibox\n```\n\n## Usage\n\n```bash \n# this will initiate the process - which should be continued by the user interface (EpiBOX app)\npython -m epibox\n```\n\n## Features\n\n- Step-by-step interactions to start the acquisition\n- History of acquisition devices\n- Default configurations for optimized interaction\n- Real-time visualization of up-to 12 channels\n- In-acquisition annotations\n\n  \n\n## Additional Resources\n\nWhy BITalino: \n - Versatility of sensors & flexibility of wearable form-factors\n - Rapid & cheap prototyping\n - Peer-validated against gold-standards\n\nWhy Raspberry Pi:\n - Discreteness\n - Affordability \n - Ease of system replication - through shell script or RPi imager\n - Computational and storage power\n\nGet to know our project @ [LinkedIn - PreEpiSeizures](https://www.linkedin.com/feed/update/urn:li:activity:6787017108631941120/)\n\n\n\n## License\n\nMIT\n\n## Contact\n\nFor any additional information about the mobile app or our project please contact me: anascacais@gmail.com\n\n=======\nHistory\n=======\n\n0.1.0 (2021-07-08)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "EpiBOX is a Raspberry Pi tool for easy signal acquisition.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/anascacais/epibox"
},
"split_keywords": [
"epibox",
" signal acquisition",
" raspberry pi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fcced0c316313082f5585f1dd0f57f23b7f64afb15da59d86cf7fd3801fe5c2b",
"md5": "b941788b974d21f0481f4eebaf2f4a01",
"sha256": "ee0e929f56b73d71a9c92a2d49fa97145b3d665e29d2faab9c0991703a15307a"
},
"downloads": -1,
"filename": "epibox-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b941788b974d21f0481f4eebaf2f4a01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.10,>=3.6",
"size": 21458,
"upload_time": "2024-08-04T15:29:07",
"upload_time_iso_8601": "2024-08-04T15:29:07.113323Z",
"url": "https://files.pythonhosted.org/packages/fc/ce/d0c316313082f5585f1dd0f57f23b7f64afb15da59d86cf7fd3801fe5c2b/epibox-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63fa58413d641be88e0b4e260c69d4b19f582105bb6b06f76c9045867ef163aa",
"md5": "4d12d97261d2adb5f7b5bd33fd6f87a9",
"sha256": "bbc148c3315417f6b55e26dfd53239e1a05d370c4104409dae5e4ee64a4d8b3b"
},
"downloads": -1,
"filename": "epibox-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4d12d97261d2adb5f7b5bd33fd6f87a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.10,>=3.6",
"size": 22235,
"upload_time": "2024-08-04T15:29:08",
"upload_time_iso_8601": "2024-08-04T15:29:08.666922Z",
"url": "https://files.pythonhosted.org/packages/63/fa/58413d641be88e0b4e260c69d4b19f582105bb6b06f76c9045867ef163aa/epibox-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-04 15:29:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anascacais",
"github_project": "epibox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "epibox"
}
JSON
