Skip to main content
Ctrl+K

IR-SIM documentation

  • Getting Started
  • User Guide
  • Configuration
  • API Reference
  • Contributing
  • Changelog
  • GitHub
  • PyPI
Text size
  • Getting Started
  • User Guide
  • Configuration
  • API Reference
  • Contributing
  • Changelog
  • GitHub
  • PyPI
Text size
  • Section Navigation

    • Make Environment
    • Configure robots and obstacles
    • Configure Sensors for the robot
    • Configure behavior for objects
    • Configure grid map environment
    • Path planning
    • Configure keyboard/Mouse control
    • Configure dynamic random environment
    • Render and Save Animation
    • User Guide

    User Guide#

    • Make Environment
      • Python script and YAML configuration file
      • Important Parameters Explanation
      • Basic Simulation Loop
      • Environment Control and Status
      • Configure Environment Title
      • Dynamic Object Management
      • Multiple Environments
    • Configure robots and obstacles
      • Robot Configuration Parameters
      • Obstacle Configuration Parameters
      • Advanced Configurations for Multiple Robots and Obstacles
    • Configure Sensors for the robot
      • LiDAR Configuration Parameters
      • FMCW LiDAR Configuration Parameters
      • FOV Configuration Parameters
    • Configure behavior for objects
      • Behavior Configuration Parameters
      • Group Behavior
      • Advanced Configuration for Custom Behavior
      • External Controller Examples (CBF / C3BF)
    • Configure grid map environment
      • Overview
      • Quick example
      • Obstacle map types
      • Built-in generators
      • Downsampling (mdownsample)
      • Adding a new map generator
    • Path planning
      • Supported algorithms
      • Example usage
    • Configure keyboard/Mouse control
      • Keyboard Control Configuration Parameters
      • Keyboard Control Key Mapping
      • Mouse Control
    • Configure dynamic random environment
      • Random Obstacles Configuration Parameters
      • Important Parameters Explanation
    • Render and Save Animation
      • Render the environment
      • Save the animation as GIF file
      • Save the animation as a video
      • 3D Plot

    previous

    Quick Start

    next

    Make Environment

    Show Source

    © Copyright 2024, Ruihua Han.

    Created using Sphinx 9.0.4.

    Built with the PyData Sphinx Theme 0.18.0.