Releases

Release v2.3.1

Release v2.3.1

Release Date: May 8, 2026

A focused maintenance release for preprocessing robustness, GUI reliability, QSI container compatibility, flex-search validation tools, and NIfTI viewer usability.

Flex-search and Simulation Workflow

  • Flex-search simulation identity and UI naming — simulator-generated flex-search runs now keep a unique storage key while showing compact, readable run labels and hover metadata in the GUI, following the run-id/run-name split used by tools such as MLflow.
  • Flex-search valid skin region controls — flex-search now exposes skin_region_margin_mm, optional landmark guarding, GUI controls, and report imagery so users can inspect and tune the valid scalp placement region used by optimization.

Reports and Visualization

  • Report and visualization follow-ups — simulation reports use clearer missing-visualization states and simulations continue when optional montage visualization cannot be generated.
  • Analyzer discovery improvements — Analyzer refreshes simulation lists when shown and after simulation completion, with clearer messages when TI/mTI post-processing outputs are missing.

NIfTI Viewer

  • Electrode NIfTI overlays — the NIfTI Viewer can create and auto-load a single label-mask overlay showing saved electrode placements from documentation/config.json. Labels are channel-based, use the same color order as montage PNGs, and are saved next to montage images under TI/montage_imgs/ or mTI/montage_imgs/ depending on simulation mode.

GUI Reliability

  • GUI lifecycle reliability — preprocessing, simulation, flex-search, ex-search, Analyzer, and NIfTI Viewer tabs now refresh dependent outputs more consistently and avoid reporting success after failed subprocesses.

Preprocessing and QSI

  • DICOM preprocessing hardening — DICOM discovery now searches nested .dcm/.dicom files and supports basic compressed inputs (.zip, .tar, .tar.gz, .tgz) in the documented sourcedata/sub-{id}/{T1w,T2w}/dicom/ layout.
  • Preprocessing existing-output handling — the GUI now detects existing outputs before rerunning DICOM conversion, CHARM, FreeSurfer recon-all, QSIPrep, QSIRecon, or DTI extraction. Users can cancel, skip existing outputs, or explicitly replace them and rerun. The same policy is available to scripts through skip_existing_outputs and replace_existing_outputs.
  • QSI Docker preflight — QSIPrep and QSIRecon now validate Docker/DooD setup early, before starting long-running container work.
  • QSI containers updated — QSIPrep and QSIRecon now target PennLINC 26.0.0, with CLI compatibility handling for QSIPrep concat and QSIRecon --input-type qsiprep.

Telemetry and Release Operations

  • Telemetry error grouping — operation telemetry now emits a per-run run_id plus a stable, path-sanitized error_fingerprint, making recurring failures easier to group without sending tracebacks or local paths.
  • Telemetry-driven preflight checks — common user/environment problems are validated before telemetry-tracked work starts for simulation, flex-search, and empty preprocessing subject selections, reducing noisy error reports while preserving real exceptions.
  • Telemetry consent persistence — GUI telemetry consent is stored in the user-level config mount and should no longer reappear every launch once answered.
  • Launcher telemetry normalization — host OS and architecture values are canonicalized across the Electron launcher and loader.py, keeping telemetry slices consistent across entrypoints.
  • Community link — README and release help links now point to the active TI-Toolbox Discord server.
  • Release-gate tests — added Dockerfile.test-based integration checks plus a self-contained comprehensive release-gate entry point using only test-environment fixtures.

Desktop App (v2.3.1): macOS Intel · macOS Apple Silicon · Windows · Linux AppImage · Linux deb

Other:

For installation instructions, see the Installation Guide.

Getting Help

If you encounter issues with this release:

  1. Check the Installation Guide for setup instructions
  2. Review the Troubleshooting section
  3. Search existing issues
  4. Ask in GitHub Discussions
  5. Join the TI-Toolbox Discord server