nkpy documentation

Library to read patient information from extracted Excel files from Nihon Kohden’s NeuroWorkbench software.

Currently only extracts video information such as their path, start date and end date.

Contents:

• Excel Files
• API Reference
• Examples

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/nkpy.git

With pip

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

Logging

Enable logging for the module with:

import logging

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

Links

• GitHub Repository