Skip to content

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.

Install from GitLab

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

Or with pip:

pip install "osechi-kazunoko @ git+https://gitlab.com/osechi/kazunoko.git"

Verify the installation

uv run kazunoko version

Example output when the detector is connected via USB:

kazunoko 0.20.0
kurikintons 1.19.3

Note

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

Development setup

To install from source for development:

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

# Install all dependencies including dev extras
uv sync --all-extras

Next Steps

See First Measurement to collect your first events.