Chapter 6 — Installation
Use the instructions supplied with your distribution
Get IRIS™ from the Saccadic download dashboard and follow its Install IRIS instructions. The distribution's Installation Guide covers prerequisites, the package installation, account/run-key setup, and verification. Do not substitute an unrelated package with a similar name.
IRIS installs as one unit. The tracker, Bench, and optional Butler relay are parts of the same distribution, not separately selected installations.
| Part | Job |
|---|---|
| Tracker | Runs inside the training process and writes diagnostic frames. |
| Bench | Opens the run directory and presents the captured measurements. |
| Butler | Optionally relays scalars to an experiment tracker you already use. |
Install into the training environment
The interpreter running training must be the interpreter into which IRIS
was installed. Activating a different environment can leave iris absent
from the shell or produce No module named 'iris' in the training script.
Installing on the machine alone is not enough.
Revision 2 lists these interpreter targets: Python 3.12, 3.13, or 3.14 on Apple silicon; Python 3.12 on Intel Mac and Linux x86_64. Follow the requirements shipped with your particular distribution if they differ.
Verify before a long job
iris --help
iris smoke --dryrun
iris --license
The dryrun smoke test checks installation wiring and licensing reachability
without consuming credits or recording science. The full iris smoke test
performs an end-to-end verification and presents its cost disclosure; read
that disclosure before proceeding. iris --license checks readiness without
starting a Bench or placing a credit hold.
Read startup messages before assuming capture is working. If the install reports that no bundle can be written, repair the named problem and rerun; successful model training does not prove that diagnostic frames were saved. See Troubleshooting.
