Metadata-Version: 2.5
Name: simready-foundation-tier-sensors
Version: 2026.8.0
Summary: SimReady Foundation sensors tier: sensor capabilities, features, requirements, and validators (nonvisual sensors, physics sensors, and render products)
Project-URL: Documentation, https://nvidia.github.io/simready-foundation/
Author: NVIDIA
License-Expression: Apache-2.0
License-File: LICENSE.txt
Requires-Python: <3.13,>=3.10
Requires-Dist: numpy
Requires-Dist: usd-validation-nvidia>=1.20.0
Provides-Extra: benchmark
Requires-Dist: simready-benchmark[kit]<2026.9.0,>=2026.8.0; extra == 'benchmark'
Requires-Dist: usd-core>=23.5; extra == 'benchmark'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Provides-Extra: usd
Requires-Dist: usd-core>=22.11; extra == 'usd'
Description-Content-Type: text/markdown

# SimReady Foundation Sensors Tier

The `simready-foundation-tier-sensors` distribution contains the sensor
capabilities, features, requirements, validator rules, and tier-owned Benchmark
runtime tests for physics sensors, RTX LiDAR, and render products.

Install validation support:

```bash
pip install simready-validate simready-foundation-tier-sensors
```

Install the optional Benchmark framework and Kit engine dependencies needed to
execute this tier's bundled runtime tests. This extra requires Python 3.12;
validator-only tier installs also support Python 3.11.

```bash
pip install "simready-foundation-tier-sensors[benchmark]"
```

## Contents

The tier owns the physics-sensors, LiDAR, and render-products capability
groups, together with their features, validation rules, profiles, and
runtime benchmark tests.

### Capabilities

- **`physics_bodies/physics_sensors`** — PS.001 (IMU sensor placement) and PS.002 (joint sensor articulation root)
- **`nonvisual_sensors/lidar`** — LI.001–LI.004 (OmniLidar schema, emitter state length, scan rate, solid-state ray count)
- **`rendering/render_products`** — RP.001–RP.006 (RenderProduct wiring, RenderVar sourceName, semantic AOV compression)

### Features

- `FET_034_ISAAC` — IMU Sensor (PS.001)
- `FET_035_RTX` — Camera and Render Products (RP.001–RP.006)
- `FET_036_RTX` — RTX Sensors (LI.001–LI.004)
- `FET_037_ISAAC` — Joint Sensor (PS.002)

## Layout

```text
simready_foundation_tier_sensors/
|-- pyproject.toml
|-- README.md
|-- simready/foundation/sensors/
|   |-- __init__.py, _plugin.py, _tier.py
|   |-- capabilities/
|   |-- features/
|   `-- profiles/
|-- simready_benchmark_kit_suite/
|   |-- README.md
|   |-- docs/
|   `-- fet034_physics_sensors/, fet035_render_products/, fet036_lidar/, fet037_joint_sensors/
`-- tests/runtime_tests/unit/
```

The shared Hatch build hook generates `simready/foundation/sensors/requirements/`
from the capability Markdown and adds those enums to the wheel. Runtime-test
documentation is colocated with the test package and assembled into the public
Foundation guide from that single source.

## Discovery

The wheel advertises two entry points:

- `usd_validation_nvidia` (`simready-validate-sensors`) -> `simready.foundation.sensors:SimReadyPlugin`
  lets the validator discover rules and requirements.
- `simready.tier` (`sensors`) -> `simready.foundation.sensors:tier` lets validation and
  Benchmark discover the tier's requirement module, catalogs, profile sources,
  and optional runtime-test package.

## Build

From the repository root:

```bash
./repo.sh build_tiers
```

On Windows use `repo.bat build_tiers`. Wheels are written to
`nv_core/tiers/_build/dist/`.

See `simready_benchmark_kit_suite/docs/authoring.md` for runtime-test authoring.
