OpenRoboTMS Project Page

This is the project page for OpenRoboTMS, an open-source robotic platform for navigated Transcranial Magnetic Stimulation (TMS). OpenRoboTMS provides accessible hardware configurations and integrates advanced robotics with medical imaging through ROS and 3D Slicer, lowering the barrier to entry for reproducible, extensible research in robot-assisted TMS.

Note: The codebase is currently being finalised and the accompanying papers are under review. All materials will be publicly released upon acceptance.

Editing the Website

The project uses HTML for content and CSS for styling.

Main Files

• index.html - Main content file with HTML "building blocks"
• static/css/ - Stylesheets for design and layout
• static/js/ - JavaScript for interactive components
• static/images/ - Images, icons, and favicon
• static/videos/ - Video files
• static/pdfs/ - PDF documents

Quick Start Guide

1. Edit index.html to update your content
2. Use or comment out the HTML sections you need
3. Replace placeholder content marked with TODO comments
4. IMPORTANT: Replace static/images/favicon.ico with your own icon

Local Development with Docker

This project includes Docker support for easy local development and preview.

Prerequisites

• Docker and Docker Compose installed on your system

Running the Project

1. Start the server (runs in the background):

   docker compose up -d

2. View the site in your browser:

   http://localhost:8080
   

3. View logs (optional):

   docker compose logs -f web

4. Stop the server:

   docker compose down

Making Changes

• Edit index.html or files in the static/ directory
• Changes are reflected immediately (you might need to hard refresh your browser)
• Hard refresh: Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac)

Tips

• Compress images with TinyPNG for better performance
• Use YouTube for large videos (>10MB) to reduce repository size
• Replace the favicon in static/images/ with your own
• Test changes locally with Docker before deploying
• Use hard refresh (Ctrl+Shift+R or Cmd+Shift+R) to clear browser cache
• Compatible with GitHub Pages for deployment

Website License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.