Synapse Installation

This guide covers the Synapse-specific install steps.

For the general setup- Telekinesis account, API key, Python environment, and the core telekinesis-ai package, follow the telekinesis-ai installation guide below.

Installation Guide

API key, Python 3.11/3.12 environment, and the base telekinesis-ai package - required before installing Synapse.

Open installation →

SUPPORTED PLATFORMS

Synapse is tested on Windows 11, Ubuntu 22.04, and macOS 13 (Ventura).

Step 1 - Install telekinesis-urdfs

Synapse depends on telekinesis-urdfs for robot model data. Clone and install it into your telekinesis conda environment:

conda activate telekinesis

git clone --depth 1 https://github.com/telekinesis-ai/telekinesis-urdfs.git
cd telekinesis-urdfs
pip install .

WARNING

telekinesis-urdfs is a large repository containing robot model data. The initial clone and wheel build are expected to take several minutes - do not interrupt the process.

Step 2 - Install Synapse

Install the Synapse extras for telekinesis-ai:

pip install "telekinesis-ai"

Step 3 - Verify the Installation

Confirm Synapse imports cleanly:

python -c "import telekinesis; from telekinesis import synapse"

No error means Synapse is ready to use.

Next Steps

Synapse Quickstart

Drive a manipulator along a Cartesian or joint-space trajectory entirely in software, visualized live in Rerun. One offline example per supported brand.

Open Synapse Quickstart →

Need help with installation?

Join the Telekinesis Discord to ask setup questions, report issues, and connect with other Physical AI developers.

Join Discord →