๐ Overview¶
Welcome to the OrcaGym documentation!
OrcaGym is an open-source robot simulation platform that provides an interface fully compatible with OpenAI Gym/Gymnasium, supporting multiple physics backends and distributed simulation.
Documentation Navigation¶
| Section | Description |
|---|---|
| ๐ What is OrcaGym | What OrcaGym is, core features at a glance |
| ๐งฌ Why Choose OrcaGym | Comparison and advantages over other simulation platforms |
| ๐ ๏ธ Installation Guide | Installation and configuration |
Quick Overview¶
OrcaGym is a cloud-native robot simulation platform with the following core features:
- :material-gym: Gymnasium Compatible โ Seamless integration with existing RL algorithms
- Multi-Physics Backend โ Supports MuJoCo, PhysX, and ODE
- Distributed Deployment โ Supports local development and remote large-scale training
- Ray Tracing Rendering โ Realistic visual observations
- Multi-Agent Support โ Native heterogeneous agent management
Who Should Use OrcaGym?¶
- Reinforcement Learning Researchers โ Need high-performance, standardized Gymnasium environments to train policies
- Robotics Developers โ Need workflows integrated with the OrcaStudio and OrcaLab platforms
- Simulation Engineers โ Need the flexibility of multiple physics backends and distributed deployment capabilities
- Educators โ Need an easy-to-use robot simulation teaching platform
Companion Products¶
OrcaGym is part of the robot simulation ecosystem:
| Product | Description |
|---|---|
| OrcaStudio | Visual scene editing and simulation management tool |
| OrcaLab | Cloud-based robot training and evaluation platform |
| OrcaGym (this repo) | Python simulation interface library |
Next Steps¶
Start with the Installation Guide, then read the Beginner's Tutorial to run your first simulation!