🛠️ Install Python SDK

Installation Requirements

• Python Version: <3.14,>=3.10

  Python Version	Support Status
  ≤ 3.9	❌
  3.10 ～ 3.13	✅
  ≥ 3.14	❌

• Package Manager: pip 23.0+ (It is recommended to use project management tools such as uv, pdm, or poetry)

• System & Architecture:

  • Windows(x86_64)

  • Linux(x86_64)

  • MacOS(aarch64)

  Note

  Supported features by platform:

  Operating System	CPU Simulation	Interactive Viewer	GPU Simulation
  Linux	✅	✅	🛠️ In Development
  Windows	✅	✅	🛠️ In Development
  MacOS	✅	✅	🛠️ In Development

  Note

  On MacOS (aarch64-apple-darwin) platform, when using 🎨 Renderer related features, you need to use the following command format:

  uv run mxpython your_script.py
  

  This is required due to the specificity of RenderApp on MacOS ARM64 platform. Using uv run mxpython ensures correct loading of rendering-related dependencies and execution environment.

  Important Notes:

  • If your code uses 🎨 Renderer, you need to use uv run mxpython

  • If your code does not use RenderApp (e.g., physics simulation only without a rendering window), use uv run which is consistent with Windows and Linux platforms

Installation Methods

Using pip

pip install motrixsim

Using uv

uv add motrixsim

Using pdm

pdm add motrixsim

Using poetry

poetry add motrixsim

Verify Installation

Using pip

pip show motrixsim

Using uv

uv pip list | grep motrixsim

Using pdm

pdm list | grep motrixsim

Using poetry

poetry show | grep motrixsim