Releases

Changelog

Complete changelog for all versions of the Temporal Interference Toolbox.

v2.2.1 (Latest Release)

Release Date: December 04, 2025

Backward compatibility change to be aware:

  • Electode Mapping: We changed the mapping functionality from the flex-seach to the simulator. This to provide a more flexible and dynamic framework. Now, the flex-search outputs the: electrode_positions.json file and the mapping functionality happeneds on the simulator side using the new method ti-toolbox/tools/map_electrodes.py. Thus, one can use a single flex-search to conveniently map to multiple nets.

Additions

  • Desktop App: Recognizing the importance of Desktop delivery, we redesign our executables with Electron. For more info please see package.
  • Benchmarks: Added benchmarking tool with sensible defaults that users can run on their systems
  • AMV: Improved automatic montage visualization that now supports all available nets with a higher resolution image.
  • Flex-search: Added more control over electrode geometry now supporting rectengular and width control.
  • Flex-search: Exapnded hyper-parameter control. tolerance and mutation rate.
  • Ex-search: Enhanced the ex-search with current ratio optimization, enabling more robust optimization process. The exhaustive search now evaluates possible electrode montages and current ratios according to the formula: $N_\text{total} = N_\text{elec}^4 \cdot N_\text{current}$, where $N_\text{current} = {(I_1,I_2) \mid I_1+I_2=I_\text{total} \wedge I_\text{step} \leq I_1,I_2 \leq I_\text{limit}}$.

Fixes

  • Various Bug Fixes: protection overwrites, documentation, output formatting, UI improvements, parallel processing, electrode management

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

Other:

v2.2.0

Release Date: November 07, 2025

Additions

  • Core Infrastructure & Architecture: The project underwent a complete restructure, removing old launcher directories and consolidating to a unified ti-toolbox structure. A new core module system was introduced in ti-toolbox/core/ with reusable components including paths.py, calc.py, constants.py, errors.py, process.py, utils.py, nifti.py, mesh.py, and viz.py. The project moved away from executable compilation and now focuses exclusively on bash entry point.
  • GUI Extensions System: A new modular extension system was introduced in ti-toolbox/gui/extensions/ providing several powerful tools. The Cluster-Based Permutation Testing (CBP) extension offers statistical analysis for group comparisons. Nilearn Visuals enables brain visualization using nilearn with glass brain views, surface plots, and slices. The NIfTI Group Averaging tool allows averaging multiple NIfTI files across subjects. The Visual Exporter provides export capabilities to Blender-compatible formats (PLY, STL) with a full tutorial. Additional extensions include Quick Notes for in-app note-taking with persistence, Subject Info Viewer for displaying metadata and processing status, and an Electrode Placement Tool for interactive electrode positioning.
  • 3D Visualization & Export: A 3D Exporter module was added in ti-toolbox/3d_exporter/ containing four specialized tools. TI_quick_volumetric.py provides fast volumetric field exports, cortical_regions_to_ply.py handles region-specific mesh exports, cortical_regions_to_stl.py outputs STL format for 3D printing, and vector_ply.py enables vector field visualization in Blender.
  • MOVEA Optimization: MOVEA-like integration was implemented for multi-objective optimization of electrode placement. The system now uses a centralized leadfield with unified leadfield target locations across all optimization tools. A complete MOVEA GUI tab provides an interface for optimization workflows.
  • Analysis Tool: Group Analyzer received significant improvements including enhanced multi-subject analysis capabilities with MNI coordinate support.
  • Statistics Module: A statistics package was created in ti-toolbox/stats/. The cluster_permutation.py module implements non-parametric cluster-based permutation testing.
  • Simulator Improvements: The simulator received substantial enhancements including a new free-hand mode that allows direct electrode coordinate input without montage selection. The entire simulator was refactored for a cleaner codebase with better error handling.
  • Optimization Tools: The flex-search tool was restructured and modularized into ti-toolbox/opt/flex/. A multi-start approach was implemented allowing multiple iterations to find the best solution. The ex-search tool received enhancements for better ROI handling and faster analysis.
  • GUI Enhancements: Multiple GUI improvements enhance the user experience. A centralized Path Manager handles path operations across all GUI tabs. Console output was standardized for consistent logging and status updates. Confirmation dialogs now appear before long-running processes. A debug mode provides optional verbose output for troubleshooting. An OpenGL fallback system provides automatic compatibility handling for macOS issues.
  • Documentation: More documentation was added covering new features. New wiki pages document cluster permutation testing, electrode placement, MOVEA optimization, tissue analyzer, visual exporter, nilearn visuals, nifti group averaging, and quick notes. A pipeline flow diagram provides visual representation of the complete workflow. A detailed Blender tutorial offers step-by-step guidance for 3D visualization. Installation documentation was streamlined with updated setup instructions and removal of executable references. The gallery was updated with new screenshots showcasing all GUI features.
  • CI/CD & Testing: A CI/CD pipeline was implemented with automated testing and Codecov integration for code coverage tracking. The test suite was expanded covering most modules, including new test files for calc, constants, core integration, mesh, errors, ex-analyzer, nifti, paths, process, utils, and MOVEA optimizer with integration tests. CircleCI integration now provides automated testing on every commit with proper permissions and workflows.
  • Development Tools: Developer experience was improved with enhanced dev environment setup in dev/bash_dev/ for contributors. Version control management was improved for better consistency across all files. The project standardized on the simnibs_python interpreter for all Python operations. Container communication between FreeSurfer and SimNIBS was enhanced for better data sharing.

Fixes

  • Bug Fixes & Refinements: Numerous bug fixes and refinements were implemented including BIDS structure compliance improvements, resolution of deadlock issues in GUI tabs, improved overwrite protection across all tools, fixed electrode naming consistency, better handling of network volumes, X11 and OpenGL fixes for cross-platform compatibility, and reduced console bloat with improved logging throughout the application.
  • Removals & Cleanup: Significant cleanup was performed removing all executable launcher code (over 7,000 lines), eliminating old MATLAB dependencies, removing outdated documentation and assets, cleaning up redundant development files.

v2.1.3

Release Date: October 08, 2025

Additions

    • Executable Launcher: pre-flight check for existing containers to avoid start conflicts.
    • Executable Launcher: validation of path input (for mannual inputs)
    • Flex-search: dynamic focality thresholding for better output
    • Development: Added a watchdog for easier GUI development
    • Analyzer: Added labeling.nii.gz as an option for voxel analysis w/o need for recon-all

Fixes

    • General: Removed env limits for flex-search, cleaned up GUI tabs, fixed Gmsh GUI lauchner with analysis visuals, fixed example data (ernie, MNI152) mounting in executable mode, clean up of executable console output.
    • Critical: Batch processing of sub-cortical targets in flex-search mode. Previous, labeling.nii.gz was no updating between subjects, causing incorrect optimization targeting.

v2.1.2

Release Date: September 08, 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

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

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