Epilepsy Tools documentation#

Documentation for the epilepsy_tools Python package, which contains pre-written function to handle data from the various connected wearables used in the epilepsy research lab at CRCHUM.

Installation#

To install the package in your project, you have two options:

With uv#

# if the project does not already exist
uv init my-project
cd my-project

uv add git+https://github.com/CRCHUM-Epilepsy-Group/epilepsy_tools.git

With pip#

pip install git+https://github.com/CRCHUM-Epilepsy-Group/epilepsy_tools.git

Logging#

Enable logging for the module with:

import logging

logger = logging.get_Logger("epilepsy_tools")
logger.setLevel(logging.DEBUG)
logger.addHandler(logging.StreamHandler())