Installation
Requirements
Section titled “Requirements”- Python 3.10+
- pip (or uv for faster installs)
Install from Source
Section titled “Install from Source”Status: The
threeweSDK is under active development.pip install threeweis not yet available on PyPI. Install from source:
git clone https://github.com/telleroutlook/3we-robot-platform.gitcd 3we-robot-platformpip install -e sdk/threewe/Verify
Section titled “Verify”The mock backend works immediately — no ROS2 or Gazebo required:
import asynciofrom threewe import Robot
async def main(): async with Robot(backend="mock") as robot: image = robot.get_image() await robot.move_to(x=2.0, y=1.0) pose = robot.get_pose() print(f"Robot at: ({pose.x:.2f}, {pose.y:.2f})")
asyncio.run(main())Who Are You?
Section titled “Who Are You?”| If you are… | Start here |
|---|---|
| AI/ML Researcher | First Robot — Gymnasium envs, VLM/VLA, trajectory recording |
| Robotics Student | Assembly Guide — Full stack from PCB to Python |
| RL Practitioner | Simulation — gym.make("threewe/NavigationEnv-v0") |
| Hardware Builder | Bill of Materials — Open BOM, CERN-OHL-P licensed |
Next Steps
Section titled “Next Steps”- First Robot — run your first navigation
- Simulation — explore Gazebo and Isaac Sim backends
- Assembly Guide — build the physical robot