API Reference#

Welcome to the IR-SIM API Reference. This section provides detailed documentation for all modules, classes, and functions in the IR-SIM package.

Core simulation loop#

The handful of entry points you will use most — everything else is reachable from the modules below.

  • irsim.make() — create an environment from a YAML scenario.

  • step() — advance the simulation by one step.

  • render() — draw the current state.

  • done() — check whether a terminal condition is reached.

  • reset() — restore objects to their initial states.

  • end() — close the environment and release resources.

  • get_robot_state() — read the primary robot’s state.

  • get_lidar_scan() — read a robot’s LiDAR scan.

API Documentation