Kernel SDK

The Kernel SDK allows you to programmatically subscribe to real-time data and assists in sending task events. For manually sending task events in your own language of choice, see Kernel Tasks SDK.

Currently, only Python is supported with more languages on the roadmap.

Python Installation

Supported Python versions:

• 3.8
• 3.9
• 3.10

Supported Operating Systems:

• Linux Ubuntu 20.04 (x86_64)
• Linux Ubuntu 22.04 (x86_64)
• macOS (amd64)
• macOS (arm64)

(Windows is on the roadmap)

pip install --index-url https://software.kernel.com/pypi/simple kernel.sdk

# view documentation
open "$(pip show kernel.sdk | grep Location: | awk '{print $2}')/kernel/sdk/docs/kernel.sdk.socket.SdkClient.html"

Reference Visualization

This application allows you to view the real-time total counts (zeroth moment) of all the detectors for a given module and wavelength. It provides reference code as a starting point in creating your own real-time applications using the Kernel SDK.

pip install --index-url https://software.kernel.com/pypi/simple kernel.sdk.viz

# install PySide6 or PyQT5
pip install pyside6

# run sample app
kernel-sdk-viz graph

# see code
open "$(pip show kernel.sdk.viz | grep Location: | awk '{print $2}')/kernel/sdk/viz/scripts"

Task Event SDK Client

# see kernel.sdk.task.TaskClient

# documentation
open "$(pip show kernel.sdk | grep Location: | awk '{print $2}')/kernel/sdk/docs/TASK.md"

# kortex ip is 127.0.0.1 (or the IP of the computer running the acquisition driver)
# kortex port is 6767