Install#

IR-SIM supports Python 3.9+ on Linux, macOS, and Windows. You can use pip or conda for installation.

Instructions

Install IR-SIM using pip:

pip install ir-sim

This will install the package and core dependencies for the base environment.

conda is a system for package and environment management.

  1. Install conda.

2. Create a new conda environment,

conda create --name irsim_env
conda activate irsim_env

or activate an existing one

3. Install ir-sim from conda-forge

conda install -c conda-forge ir-sim

uv is an extremely fast Python package and project manager.

Install IR-SIM using uv:

uv pip install ir-sim

or use uv’s project management:

uv add ir-sim

We strongly recommend using a fresh virtual environment (uv or conda) when installing IR-SIM from source.

The dependencies of IR-SIM are listed in the pyproject.toml file. All required packages are installed automatically alongside IR-SIM.

Perform the following steps to install IR-SIM from source:

  1. Clone the official IR-SIM git repository, or a newly minted fork of the IR-SIM repository.

  2. Navigate to the top-level of the cloned directory.

  3. If you want to use IR-SIM with editable source code, run

pip install -e .

otherwise, run

pip install .

Install with Additional Features#

Keyboard Control

IR-SIM supports keyboard control for interactive robot simulation. Install the keyboard control dependencies:

pip install ir-sim[keyboard]

This installs:

  • pynput - For keyboard and mouse input handling

  • tabulate - For formatted table output

Testing

IR-SIM comes with a comprehensive test suite. Install the testing dependencies:

pip install ir-sim[test]

This installs:

All Features

To install all optional dependencies and features:

pip install ir-sim[all]

This includes:

  • Keyboard control features (pynput, tabulate)

  • Testing framework (pytest, pytest-cov)

  • Enhanced video support (imageio[ffmpeg])

Running the test suite#

IR-SIM comes with a comprehensive test suite, which can be run after installing pytest. If installed from source, navigate to the root of the repository and run

pytest