project_superdex README

The project's README from github.com/facebookresearch/project_superdex. As one markdown file: README.md.

Project SuperDex

A unified platform for dexterous manipulation research

Welcome to Project SuperDex.

SuperDex brings together a purpose-built physics engine, robotics authoring tools, and a scalable reinforcement learning interface in a unified simulation platform, with VR-based teleoperation and additional capabilities planned for future releases.

Visit the Project SuperDex website for more.

Threaded Screw Manipulation
Threaded Screw Manipulation

Building blocks


The following videos were recorded in real-time using SuperDex Teleop (available in Q4 2026).

Soft Sponge Fruit Bag
Soft Sponge Fruit Bag
Cereal Box Rope Braid
Cereal Box Rope Braid
Contact Viz Puzzle Cube
Contact Viz Puzzle Cube
Compose Bots Soft Fingertips
Compose Bots Soft Fingertips

SuperDex Studio

SuperDex Studio is the desktop application where you turn raw CAD and robot descriptions into native SuperDex Assets - bots, prefabs, and scenes. This is the GUI toolkit of Project SuperDex.

Click to learn more about SuperDex Studio.

SuperDex Studio Apply Forces
SuperDex Studio Apply Forces

SuperDex Lab (early preview)

SuperDex Lab connects simulation and policy development through a Gymnasium-style API for reinforcement learning. It is currently in early preview and will receive substantial improvements.

Click to learn more about SuperDex Lab.

Reinforcement Learning


Q4 2026: SuperDex Teleop

SuperDex Teleop is the next major module coming to Project SuperDex. Initial components for Unreal Engine 5 based virtual teleoperation will be available in Q4 2026.

Ben Virtual Teleop

SuperDex Teleop runs natively on-device on Quest 3. No remote PC, no streaming. Includes support for both hand tracking and controllers including mixed mode. Runs in pure C++ for low-latency, real-time, scalable virtual teleop.

Android Teleop


Requirements

Get the Source Code and Examples

Quick Start (Python)

Project SuperDex has first-class support for Python across the board. The quickest way to get started is with uv and pypi wheels.

  1. Install pre-requisites
    • uv
    • Linux Only: SuperDex Studio and SuperDex Physics Debugger require an available X11 display (native X11 or XWayland), a graphics driver supporting OpenGL 4.1, and the following runtime components:
      • Ubuntu/Debian: sudo apt install libgl1 libx11-6 libx11-xcb1 libxcb1 libxext6 libxrandr2 libxinerama1 libxcursor1 libxi6 zenity
      • Fedora/RHEL: sudo dnf install libglvnd-glx libX11 libX11-xcb libxcb libXext libXrandr libXinerama libXcursor libXi zenity
  2. cd into the project_superdex source directory
  3. Create venv uv venv
  4. Pip Install: uv pip install superdex
  5. Run
    • Optional: To run Python examples in double precision (float64), set the environment variable SUPERDEX_PRECISION=double; otherwise, single precision is used.
    • Physics example: uv run --no-project superdex_physics/examples/example_tendon_comparison.py
    • Robotics example: uv run --no-project superdex_robotics/examples/control/example_osc_jsc_control.py
    • SuperDex Studio: uv run --no-project superdex-studio
    • Note: --no-project is required for uv run cmds within this repo or else it will build from source

Building from Source

Install Pre-requisites

Building from Source (Python)

  1. Get the source code and install pre-requisites (see above)
  2. Windows only: From the Start menu, launch the x64 Native Tools Command Prompt matching your installed Visual Studio version (e.g. x64 Native Tools Command Prompt for VS 2022).
  3. cd into the project_superdex source directory
  4. Build: uv sync --extra gui -v
  5. Run:
    • Physics example: uv run superdex_physics/examples/example_tendon_comparison.py
    • Robotics example: uv run superdex_robotics/examples/control/example_osc_jsc_control.py
    • SuperDex Studio: uv run superdex-studio

Flags for uv sync are:

uv sync flags (additive) Build targets
none build tools only
--extra core physics, robotics, lab
--extra gui core + physics-debugger, studio, mesh-cli
--extra double core + physics-fp64, robotics-fp64
--all-extras everything

NOTE: Running the examples above requires --extra gui.

NOTE: --extra double builds the double-precision bindings, but single precision is still the default at runtime. To run Python examples in double precision, set the environment variable SUPERDEX_PRECISION=double.

Building from Source (C++)

Core modules such as SuperDex Physics and SuperDex Robotics are written in C++ and exposed to Python. Full C++ examples will be shared in the future. Users who are interested in calling C++ directly can get started via CMake.

  1. Get the source code and install pre-requisites (see above)
  2. Windows only: From the Start menu, launch the x64 Native Tools Command Prompt matching your installed Visual Studio version (e.g. x64 Native Tools Command Prompt for VS 2022).
  3. cd into the project_superdex source directory
  4. Configure lean Release build: cmake -B build -DCMAKE_BUILD_TYPE=Release -DMOCHI_BUILD_DEBUGGER=OFF -DMOCHI_USE_PYBIND=OFF -G Ninja
  5. Build: cmake --build build --parallel

NOTE: To build the C++ libraries in double precision, add -DMOCHI_USE_DOUBLE_PRECISION=ON when configuring CMake. Otherwise, single precision will be used by default.


Documentation

Documentation, getting started guides, and examples are available for all modules.


How to Contribute

We welcome contributions! Go to CONTRIBUTING and our CODE OF CONDUCT for how to get started.

Reporting Issues

Please report issues via GitHub Issues.

License

First-party SuperDex source code is licensed under Apache 2.0. Assets and documentation are licensed under CC-BY-4.0 except where otherwise noted. Third-party and derived code and assets retain their own terms, recorded in their accompanying LICENSE and NOTICE files. superdex_mesh_cli is an optional, standalone mesh processing CLI tool released under GPLv3 due to use of OCCT and CGAL.

Third-party license families represented in this repository include Apache-2.0, BSD-2-Clause, BSD-3-Clause, BSL-1.0, CC-BY-4.0, CC0-1.0, GPL-3.0-or-later, LGPL-2.1 with the OCCT exception, LGPL-3.0-or-later, MIT, MPL-2.0, SIL OFL-1.1, HDF5, libpng, public-domain, zlib, Zstandard, and component-specific commercial or asset terms. The accompanying license and notice files are authoritative for each component or asset.

Certain third party dependencies and third party assets in this repo are licensed for non-commercial/academic uses only. You must ensure that you, as the user, access and use such third party dependencies and assets in compliance with their respective licenses.


Citation

Citation details will be added here upon publication.

project_superdex (facebookresearch/project_superdex)

Searching Database…

这是什么?Project SuperDex 是 Meta 推出的灵巧操作研究统一仿真平台,结合了以接触为先的物理引擎、机器人创作工具和强化学习接口,基于 VR 的遥操作计划于 2026 年第四季度推出。
这是一个工具,还是捆绑在一起的多个模块?它是同一平台下的四个构件:SuperDex Physics(物理引擎)、SuperDex Robotics(机器人 SDK)、SuperDex Studio(用于资产创作的桌面 GUI)和 SuperDex Lab(RL/MPC 仿真框架)。
怎么把它跑起来?安装 uv,然后运行 'uv venv' 创建虚拟环境,运行 'uv pip install superdex' 拉取 PyPI 轮子;之后你可以用 'uv run --no-project' 运行自带的物理、机器人或 SuperDex Studio 示例。
尝试之前需要装好什么?你需要 Python 3.12,因为预构建轮子目前只针对该版本,另外还需要 uv 包管理器;从源码构建还需要 CMake 3.25+、Ninja 和平台编译器(Linux 上是 Clang,macOS 上是 Xcode 工具,Windows 上是 MSVC Build Tools)。
SuperDex Lab 现在能用于严肃的 RL 工作吗?Gymnasium 风格的 RL 接口 SuperDex Lab 明确处于早期预览阶段,预计会有大幅变化;VR 遥操作模块则完全还没提供,计划在 2026 年第四季度推出。
它实际支持哪些操作系统?只支持 Linux x86_64、Windows x86_64 和 Apple Silicon(ARM)上的 macOS;不支持 Intel Mac。
整个仓库都采用同一个简单许可证吗?SuperDex 第一方代码采用 Apache-2.0,资产和文档采用 CC-BY-4.0,但捆绑的网格处理 CLI 工具因为使用了 OCCT 和 CGAL 而采用 GPLv3,此外部分第三方依赖和资产仅限非商业或学术用途。
SuperDex Teleop 是什么?什么时候推出?SuperDex Teleop 是即将推出的 VR 遥操作模块,计划 2026 年第四季度发布,用纯 C++ 构建,以实现低延迟实时控制。它直接在 Quest 3 头显上本地运行,无需远程 PC 或串流,支持手部追踪、控制器和混合模式。
SuperDex Studio 到底做什么?SuperDex Studio 是一个轻量级桌面 GUI 应用,用于在机器人、网格、任务预制件和场景等仿真资产进入 SuperDex Physics 或 Lab 之前创建、编辑和验证它们。
可以用双精度运行仿真吗?可以。默认是单精度,但设置环境变量 SUPERDEXPRECISION=double 可以把 Python 示例切换到 float64;用 --extra double 构建则会编译双精度绑定。
在 RL 训练方面 SuperDex Lab 提供什么?它提供 Gymnasium 风格的 API,抽象了底层的马尔可夫决策过程和动力学约束优化,因此可以支撑强化学习、MPC 和系统辨识工作流。
Size
761 MB
Stars
742
Age
1mo
Commits · 90 Days