Biomag TMS Experiment Dashboard

Web-based graphical interface for visualization, control and documenting events during TMS experiments coupled with EMG using neuronavigation with InVesalius.

📋 Requirements

• Python 3.11 – 3.12 (recommended: 3.11)

🚀 Quick Installation

Option 1: With uv (Recommended)

# Clone source repository
git clone git@github.com:biomaglab/tms-experiment-dashboard.git
cd tms-experiment-dashboard

# Install NiceGUI
uv sync --extra nicegui

Option 2: With pip/venv (Traditional)

# Clone source repository
git clone git@github.com:biomaglab/tms-experiment-dashboard.git
cd tms-experiment-dashboard

# Create a virtual environment
python -m venv .venv

# Activate the virtual environment
# Windows:
.venv\Scripts\activate
# Linux/Mac:
source .venv/bin/activate

# Install dependencies
pip install -e .

# Install NiceGUI
pip install -e .[nicegui]

✨ How to Use

1. Start the relay server.

With uv:

uv run python scripts/relay_server.py 127.0.0.1 5000

With pip/venv:

# Make sure the virtual environment is activated
python scripts/relay_server.py 127.0.0.1 5000

2. (Optional) Start InVesalius

python /path/to/invesalius3/app.py --remote-host http://localhost:5000

3. Start the Dashboard

With uv:

# Automatic detection (NiceGUI)
uv run python main.py

With pip/venv:

# Make sure the virtual environment is activated
python main.py

To acess the web GUI:

• Open your web browser and navigate to: http://localhost:8084

License

This project is licensed. Check the file. LICENÇA for further details.

Supported by NeuroMat

This work is supported by NeuroMat - Centro de Pesquisa, Inovação e Difusão em Neuromatemática (CEPID NeuroMat) established in 2013 at the University of São Paulo (USP). Homepage: http://neuromat.numec.prp.usp.br