Welcome to IR-SIM’s documentation!#

IR-SIM is an open-source, Python-based, lightweight robot simulator designed for navigation, control, and learning. It provides a simple, user-friendly framework with built-in collision detection for modeling robots, sensors, and environments. Ideal for academic and educational use, IR-SIM enables rapid prototyping of robotics and AI algorithms in custom scenarios with minimal coding and hardware requirements.

🚀 Quick Start

Get up and running with IR-SIM in minutes

Get Started

📚 User Guide

Learn how to use IR-SIM effectively

User Guide

⚙️ Configuration

YAML configuration syntax and examples

YAML Configuration Syntax

🔧 API Reference

Complete API documentation

API Reference

📋 Changelog

Version history and release notes

Changelog

🤝 Contributing

Guide for contributors

Contributing to IR-SIM

Key Features#

Simulate a wide range of robot platforms with diverse kinematics, sensors, and behaviors
Quickly configure and customize simulation scenarios using straightforward YAML files, with no complex coding required
Visualize simulation outcomes in real time for immediate feedback and analysis using matplotlib
Support collision detection and behavior control for each object in the simulation