Quick Start

Get from download to your first project in three steps. Docker runs the scientific tools; the desktop app brings them together.

Before you begin: 32 GB RAM, 4 CPU cores and 20 GB free disk space, plus room for your project. Recommended: 64 GB RAM and 8+ cores. Full requirements →

1. Start Docker

Choose your system for setup instructions. No separate SimNIBS or X11 installation is needed.

macOS

Install Docker Desktop for your Mac’s chip, open it and wait until the engine is running.

Apple menu → About This Mac shows whether you have Apple Silicon or Intel. Scientific processing runs under emulation on Apple Silicon.

macOS setup help →
Windows

Install Docker Desktop with its WSL2 backend, open it and wait until the engine is running.

Windows / WSL2 setup help →
Linux

Install Docker Engine and Docker Compose for your distribution. Start the engine and check that your account can run docker version.

Linux setup help →

2. Install TI-Toolbox

Choose the download for your computer.

TI-Toolbox v3.0.2 desktop downloads
Your computerProcessorInstaller
macOS Apple Silicon Apple M-series Download .dmg
macOS Intel Intel processor Download .dmg
Windows 64-bit (x64) Download .exe
Linux AppImage 64-bit (x64) Download .AppImage
Linux Debian / Ubuntu 64-bit (amd64) Download .deb

All release files, including macOS ZIPs · SHA-256 checksums

How do I install the downloaded file?
  • macOS: open the DMG, drag TI-Toolbox to Applications, then open it.
  • Windows: run the EXE installer, then open TI-Toolbox from the Start menu.
  • Linux: install the DEB using your package manager, or mark the AppImage executable and run it.

3. Open a project

  1. Open TI-Toolbox
    Keep Docker running.
  2. Choose your project folder
    Use Browse or enter its full path, then select Open project.
  3. Let the first launch finish
    The toolbox downloads its scientific environment. This needs internet access and may take a while.

Your project stays on your machine. Use Switch project in Overview to open another folder; closing the desktop app stops its container and preserves your files.

Explore your workspace → Try example data →

Other ways to launch

Use a terminal or browser instead

Download loader.py and docker-compose.yml into the same folder, keeping their filenames unchanged. Open a terminal there and run:

python3 loader.py

Requires Python 3.11+ and Docker. The launcher downloads and opens the desktop app; add --browser to use your browser instead. A browser session keeps running after its tab closes. Inside WSL2 the launcher always uses your Windows browser; the desktop app on Windows is the installer above.

The command-line guide covers the Bash launcher, project paths, existing sessions and stopping a container.