KLUSTA(1)

📦 version 3.0.16, in fedora 43

👑 KLUSTA 💅

okay bestie, welcome to klusta — it's a User Command, it lives in section 1 of the manual, and it is literally here to spikesort your dataset. no cap. 🧚✨

✨ NAME ✨

klusta — spikesort a dataset 🦋

🌸 SYNOPSIS 🌸

klusta [OPTIONS] PRM_FILE

that's it. that's the whole vibe. options, then your PRM file. periodt. 💖

💜 DESCRIPTION 💜

Spikesort a dataset. yes queen, that's the whole job description and she ate. 🔥

By default, klusta performs spike detection (with SpikeDetekt) and automatic clustering (with KlustaKwik2) — the whole glow-up, start to finish. But bestie, you can also choose to run only one step if that's the energy you're on. 🙈

You need to specify three pieces of information to spikesort your data, and no you cannot skip any of them, i'm so serious:

  • The raw data file — typically a .dat file. 🍓
  • The PRM file — a Python file with the .prm extension, containing the parameters for your sorting session. this one goes in the command line, iykyk.
  • The PRB file — a Python file with the .prb extension, containing the layout of your probe. 🔍

three little files, one big slay. 🌈

💅 OPTIONS 💅

  • --output-dir DIRECTORY — where the output goes. your output directory, bestie. 🎀
  • --interval <FLOAT FLOAT>... — interval in seconds, e.g. --interval 0 2. two floats, one interval. 👑
  • --channel-group INTEGER — the channel group to cluster. all of them by default, because she's generous like that. 💖
  • --detect-only — only do spike detection. that's it. just the detection. nothing else. 💀
  • --cluster-only — only do automatic clustering. skip the detection, go straight to the clustering. main character energy. ✨
  • --legacy-output — save .res and .clu files in addition to .kwik. for the people who still want the old files. we love a nostalgic moment. 🫶
  • --overwrite — overwrite the Kwik file. be careful bestie, she will not ask twice. 😭
  • --debug — use the DEBUG logging level. everything gets loud. 🔥
  • --version — show the version and exit. quick lil flex. 🌸
  • --help — show this message and exit. you're already here tho. 🙈
heads up bestie: --detect-only and --cluster-only are how you run just one step, and --overwrite really does overwrite the Kwik file, so like… know what you're doing. 💅

this lil icon was brought to you by klusta 3.0.16, dated June 2025 — mwah, kiss the manual goodbye, go sort some spikes 💋🌈✨

📦 where this page comes from