Skip to main content

IR-SIM is an open-source, lightweight robot simulator based on Python, designed for robotics navigation, control, and learning. This simulator provides a simple and user-friendly framework for simulating robots, sensors, and environments, facilitating the development and testing of robotics algorithms with minimal hardware requirements.

Project description

Intelligent Robot Simulator (IR-SIM)

A lightweight, YAML-driven robot simulator for navigation, control, and learning

arXiv Paper PyPI Version Python Version CI Coverage Docs License Downloads

Overview

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 learning algorithms in custom scenarios with minimal coding and hardware requirements.

Key Features

  • Simulate robot platforms with diverse kinematics, sensors, and behaviors (support).
  • Quickly configure and customize scenarios using straightforward YAML files. No complex coding required.
  • Visualize simulation outcomes using a naive visualizer matplotlib for immediate debugging.
  • Support collision detection and customizable behavior policies for each object.
  • Suitable for mutli-agent/robot learning (Projects).

Demonstrations


Multi-Robot RVO Collision Avoidance
Source

Ackermann Robot with 2D LiDAR
Source

HM3D / MatterPort3D Grid Map
Source

Field-of-View Detection
Source

Dynamic Random Obstacles
Source

200-Agent ORCA via pyrvo
Source

Installation

Requires Python >= 3.10

pip

pip install ir-sim

# Optional: keyboard control and all extras
pip install ir-sim[all]

From source

git clone https://github.com/hanruihua/ir-sim.git
cd ir-sim
pip install -e .

uv

git clone https://github.com/hanruihua/ir-sim.git
cd ir-sim
uv sync

Quick Start

A minimal example: a differential-drive robot navigates toward a goal using the built-in dash behavior.

import irsim

env = irsim.make('robot_world.yaml') # initialize the environment with the configuration file

for i in range(300): # run the simulation for 300 steps

    env.step()  # update the environment
    env.render() # render the environment

    if env.done(): break # check if the simulation is done

env.end() # close the environment

YAML Configuration: robot_world.yaml

world:
  height: 10  # the height of the world
  width: 10   # the width of the world
  step_time: 0.1  # 10Hz calculate each step
  sample_time: 0.1  # 10 Hz for render and data extraction
  offset: [0, 0] # the offset of the world on x and y

robot:
  kinematics: {name: 'diff'}  # omni, omni_angular, diff, acker
  shape: {name: 'circle', radius: 0.2}  # radius
  state: [1, 1, 0]  # x, y, theta
  goal: [9, 9, 0]  # x, y, theta
  behavior: {name: 'dash'} # move toward to the goal directly
  color: 'g' # green

For more examples, see the usage directory and the documentation.

Support

Category Features
Kinematics Differential Drive mobile Robot · Omnidirectional mobile Robot · Omnidirectional with Angular control · Ackermann Steering mobile Robot
Sensors 2D LiDAR · 2D FMCW LiDAR · FOV Detector
Geometries Circle · Rectangle · Polygon · LineString · Binary Grid Map · Fog of Map
Behaviors dash (move directly toward goal) · RVO (Reciprocal Velocity Obstacle) · ORCA (Optimal Reciprocal Collision Avoidance) · SFM (Social Force Model)

Documentation

Projects Using IR-SIM

Academic Publications

  • [RAL & ICRA 2023] rl-rvo-nav -- Reinforcement learning-based RVO behavior for multi-robot navigation.
  • [RAL & IROS 2023] RDA_planner -- Accelerated collision-free motion planner for cluttered environments.
  • [T-RO 2025] NeuPAN -- Direct point robot navigation with end-to-end model-based learning.

Community Projects

  • DRL-robot-navigation-IR-SIM -- Deep reinforcement learning for robot navigation.
  • AutoNavRL -- Autonomous navigation using reinforcement learning.
  • IRSIM-3DGS-Bridge -- A closed-loop bridge from 3D Gaussian Splatting scenes to IR-SIM planning/following and back to Habitat-GS trajectory playback.

Citation

If you find IR-SIM useful, please consider starring ⭐ this project and citing our paper:

@article{han2026ir,
  title={IR-SIM: A Lightweight Skill-Native Simulator for Navigation, Learning, and Benchmarking},
  author={Han, Ruihua and Wang, Shuai and Li, Chengyang and Gao, Rui and Wang, Xinyi and Liu, Zhe and Li, Guoliang and Lu, Yupu and Hao, Qi and Pan, Jia and Zhao, Hengshuang},
  journal={arXiv preprint arXiv:2606.08729},
  year={2026}
}

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Acknowledgement

License

IR-SIM is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ir_sim-2.10.1.tar.gz (803.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ir_sim-2.10.1-py3-none-any.whl (742.5 kB view details)

Uploaded Python 3

File details

Details for the file ir_sim-2.10.1.tar.gz.

File metadata

  • Download URL: ir_sim-2.10.1.tar.gz
  • Upload date:
  • Size: 803.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for ir_sim-2.10.1.tar.gz
Algorithm Hash digest
SHA256 4c05f6d3541ab2ac6425326b90a4feecfe1a1759528d4661a6abecfba36709f3
MD5 5285b73856c00b2f0cef399e120050ff
BLAKE2b-256 dd2d61d92ee7afc38b7a12a720e130377ccce8dfc3f4295630cb4b9b5fa3a47b

See more details on using hashes here.

File details

Details for the file ir_sim-2.10.1-py3-none-any.whl.

File metadata

  • Download URL: ir_sim-2.10.1-py3-none-any.whl
  • Upload date:
  • Size: 742.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for ir_sim-2.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 271afdac48f42f6433c01d7d5704543724af819e731e849d4bfb7bc768122db1
MD5 bb8f7b57cea6a3d5688104aee9957970
BLAKE2b-256 8616d4f8820c6e9640be9e9dacb3682d619dea1bef0cbc51d7f5873339cdbf8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page