Installation¶

Requirements¶

Python 3.11+
uv (recommended) or pip
kurikintons 1.10.1+ on the OSECHI detector (2.x recommended)

kurikintons firmware

kurikintons is the event detection firmware running on the OSECHI detector. It is not a direct dependency of kazunoko, but the output format must be compatible. kazunoko can read events from kurikintons 1.10.1 and later. Version 2.x is recommended for the best compatibility.

For Users¶

If you only need the kazunoko CLI and do not plan to modify the source, install directly from GitLab without cloning the repository.

As a standalone tool (`uv tool`)¶

Install into an isolated environment and expose kazunoko globally:

# Core only
uv tool install "osechi-kazunoko @ git+https://gitlab.com/osechi/kazunoko.git"

# Verify
kazunoko --help

As a project dependency (`uv pip`)¶

Add to your project's virtual environment:

uv venv --python 3.14
uv pip install "osechi-kazunoko @ git+https://gitlab.com/osechi/kazunoko.git"

# Pin to a specific release tag
uv pip install "osechi-kazunoko @ git+https://gitlab.com/osechi/kazunoko.git@0.27.0"

Verify the installation¶

uv run kazunoko version

Example output when the detector is connected via USB:

kazunoko 0.27.0
kurikintons 2.6.0

Note

The firmware version (kurikintons) is only shown when an OSECHI detector is connected.

For Developers¶

Prerequisites¶

Tool	Version	Install
go-task	v3	`brew install go-task`
uv	latest	`brew install uv`

Get from source¶

git clone https://gitlab.com/osechi/kazunoko.git
cd kazunoko

Set up the environment¶

task env:setup

This runs:

uv sync --all-groups — installs all Python dependencies into .venv
uv run pre-commit install — installs git commit hooks

Verify¶

uv run kazunoko --help

Clean up¶

task env:clean

Next Steps¶

See First Measurement to collect your first events.