simready-benchmark-engine-kit

Kit / Isaac Sim engine plugin for SimReady Benchmark. Provides KitPlugin, registered with the framework through the simready_benchmark.engines entry-point group.

This wheel is the bridge between simready-benchmark (engine-agnostic core) and a separately-installed Kit / Isaac Sim runtime.

Installation

pip install simready-benchmark-engine-kit
# Equivalent to:
pip install simready-benchmark[kit]

Both forms pull in simready-benchmark and usd-core as transitive dependencies.

Python 3.11 or newer is required.

Kit / Isaac Sim itself is NOT a PyPI package. Install it separately through the NVIDIA Omniverse Launcher or your organization's internal package manager. Point the framework at the install through engines.toml:

[kit.isaac_sim]
executable_path = "C:/Program Files/NVIDIA/IsaacSim/2025.1/isaac-sim.bat"
version = "5.1.0"
tags = ["isaac", "kit"]

What This Wheel Provides

• KitPlugin. The framework-facing EnginePlugin implementation; loaded automatically through the simready_benchmark.engines:kit entry-point.
• KitSession. A single Kit subprocess and the lifecycle around it.
• KitLogCapture. Structured ingest of Kit's log lines.
• build_kit_command, resolve_kit_runner_path. Helpers for composing the Kit invocation from an EngineConfig.

End-user @test-decorated functions interact with Kit through ctx.scene on the RunContext (a SceneHandle whose concrete type is KitSceneHandle when this plugin is active).

Configuration

The plugin reads engine paths from engines.toml. 4-tier lookup (first match wins):

1. --engines-toml <FILE> CLI flag
2. $SIMREADY_ENGINES_TOML env var (missing file is a hard error)
3. engines.toml in the current working directory
4. ~/.simready-benchmark/engines.toml

A [engines.toml] <path> line is written to stderr one time per process when a file is loaded, so the user can identify which tier matched. Suppress with SIMREADY_QUIET_ENGINES_TOML=1. Scaffold a starter with simready-benchmark --init-engines-toml.

Required fields per engine instance:

Optional sections (handled at the framework level, not the plugin):

Compatibility

• Tested against Isaac Sim 5.1 (Kit 106.5-based).
• Inside Kit, from pxr import ... resolves through the Kit runtime. Outside Kit (for plain-Python unit tests, CLI listing, or static analysis on a developer machine without Kit installed), usd-core provides the same pxr module. usd-core is the headless USD distribution; no GPU/Hydra renderers, so it does not bloat installs that already have Kit.

License

Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0