Releases

Changelog

Complete changelog for all versions of the Temporal Interference Toolbox.

v2.1.2 (Latest Release)

Release Date: September 07, 2025

Additions

  • Example Dataset: Toolbox now ships with Ernie & MNI152 MRI scans for quick start & learning purposes.
  • Tissue Analyzer: Added skin thickness and volume analysis

Fixes

  • Various bug fixes: charm, ex-search, flex-search

v

v2.1.1

Release Date: August 28, 2025

Additions

  • N/A

Fixes

  • ex-search: fixed final.csv output
  • flex-search: fixed cleanup of directory if users choose a single start

v

v2.1.0

Release Date: August 25, 2025

Additions

  • Improved BIDS formatting: Enhanced Brain Imaging Data Structure (BIDS) compliance and formatting for better data - organization and compatibility
  • Debug mode for console output: Introduced comprehensive debug mode with detailed console logging for troubleshooting and development
  • Inter-individual variability assessment: New bone analyzer tool integrated into pre-processing pipeline for assessing anatomical variations between subjects
  • Multi-start approach for flex-search optimization: Implemented multi-start optimization strategy to counter local maxima issues in electrode placement optimization

Fixes

  • Removed MATLAB runtime dependency: Eliminated MATLAB runtime requirement, making the toolbox fully independent and easier to deploy
  • mTI bug fixes and upstream integration: Resolved critical bugs in mTI (multi-channel Temporal Interference) functionality and improved integration with upstream SimNIBS components
  • Enhanced X11 handling for macOS: Improved X11 server integration and display management for better GUI - functionality on macOS systems
  • Official rebranding: Complete renaming from TI-CSC to TI-Toolbox across all components, documentation, and user interfaces

v2.0.5

Release Date: July 10, 2025

Additions

  • Group Analysis Features: Group analysis system with GUI interface, comparison capabilities, and logging
  • Focality Measurement: New focality analysis tools with histogram generation for cortical analysis
  • Normal Component Analysis: Added normal component matrics and visualization
  • Enhanced Workflow: Multiple subject selection for flex-search, new naming conventions

Fixes

  • GUI Stability: Multiple bug fixes for group analysis GUI, element resizing, console widget consistency, and special character handling
  • Analysis Accuracy: Improved histogram generation, ROI comparison plots
  • Visualization: Fixed mesh visualization and updated mesh visualizer functionality

v2.0.4

Release Date: June 26, 2025

Additions

  • flex-search -> simulator integration. Simulator now recognizes previous flex-searches and allows for simulation of both optimized and mapped electrodes.
  • system monitor -> added a GUI tab that allows users monitor the activity of processes hapenning within the toolbox

Fixes

  • pre-process -> added missing shell for recon-all step
  • pre-process -> fixed parallalization problem
  • ex-search redesign -> now is not dependent on MATLAB Runtime, but is fully Python implemented
  • ex-search -> users can now creat multiple leadfields for the same subject
  • flex-search -> post processing method for TI envelope direction is implemented

v2.0.3

Release Date: June 20, 2025

Additions

  • Modified tes_flex_optimization.py to include eeg_net field in the .json
  • toggle between “Montage Simulation” (traditional) and “Flex-Search Simulation” with automatic discovery of optimization results and electrode type selection (mapped/optimized/both)
  • Modified TI.py and pipeline scripts to handle direct XYZ electrode coordinates instead of just electrode names, enabling optimized electrode positioning from flex-search results

Fixes

  • N/A

v2.0.2

Release Date: June 19, 2025

Additions

  • Enhanced X11 support for Windows with automatic host IP detection and VcXsrv/Xming configuration guidance
  • Created windows_x11_setup.sh helper script for simplified Windows X server setup
  • Added comprehensive Windows BIDS path guide (WINDOWS_BIDS_PATH_GUIDE.md) with troubleshooting tips
  • Improved cross-platform X11 configuration with better error handling and user guidance
  • Added OpenGL software rendering flags for better GUI compatibility across all platforms

Fixes

  • Fixed volume mounting in docker-compose.yml - all required volumes now properly mounted to simnibs container
  • Fixed Windows path handling - automatic conversion of backslashes to forward slashes for Docker compatibility
  • Fixed paths with spaces on Windows - automatic quoting of paths containing spaces
  • Fixed X11 socket mounting for macOS XQuartz and Linux compatibility
  • Fixed DISPLAY environment variable configuration for Windows, macOS, and Linux
  • Fixed MATLAB Runtime library paths in container environment
  • Updated XQuartz version warning to reference memory about v2.7.7 compatibility requirement

v2.0.1

Release Date: June 11, 2025

Additions

  • new logger and report generators under ‘projectDIR/derivatives/’
  • sub-cortical atlas based targeting for flex-search (example: thalamus targeting)

Fixes

  • 2 decimal spherical ROIs
  • ‘TI.py’ overwrite protection removed
  • intenral 185 EGI net (removed 2 missed electrodes)
  • added imagemagick for montage visualizer

v2.0.0

Release Date: May 28, 2025

Major Changes

  • Complete rewrite of the Temporal Interference Toolbox with major enhancements: Cross-platform support for Windows, macOS, and Linux
  • Docker-based containerization for consistent environment and reproducibility
  • Dual interface with both GUI and CLI support, enabling local and remote server usage
  • Key functionalities include DICOM to NIfTI conversion, FreeSurfer segmentation, SimNIBS head modeling, flexible and exhaustive electrode optimization algorithms, FEM-based temporal interference field calculations, and comprehensive analysis tools with atlas-based ROI evaluation

Installation

Version Support

We actively support and maintain versions 2.x.x and newer of the Temporal Interference Toolbox. Versions 1.x.x are no longer supported.

Getting Help

If you encounter issues with any release:

  1. Check the Installation Guide for setup instructions
  2. Review the Troubleshooting section
  3. Search existing issues
  4. Ask in GitHub Discussions