NVIDIA / NVIDIA/simready-foundation
simready-benchmark: --output-dir is honoured by the run stage but ignored by the plan stage, so the run always aborts
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 88
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Passing --output-dir to simready-benchmark makes the run fail every time. The plan stage ignores the flag and writes plan.json to the path derived from project_config.toml, but the run stage honours it and looks for plan.json under the directory that was passed. The run then aborts because the plan is not where it expects.
simready-benchmark 2026.6.5.
Reproduction
$ simready-benchmark --assets <asset>.usd --output-dir D:\some\other\dir
{"type": "plan_complete",
"output": "D:\...\simready-foundation\_testing\plan.json", <-- flag ignored
"assets": 1, "profiles": 1, "tests": 9, "runs": 8, "warnings": 0}
{"type": "cli_error", "error": "plan_load_failed",
"message": "Failed to load plan: [Errno 2] No such file or directory:
'D:\some\other\dir\plan.json'"} <-- flag honoured
The plan is generated successfully (8 runs) and written to {project_root}/_testing/plan.json, while the run stage looks in <output-dir>/plan.json.
--help documents the flag as:
--output-dir DIR Output directory for run/report (default: {project_root}/_testing).
so "run" output is explicitly in scope for the flag.
Also visible in --show-config
--show-config reports output_dir as resolved from project_config, and setting [paths].output_dir in engines.toml has no effect either — project_config wins:
output_dir
----------
resolved: D:\...\simready-foundation\_testing
contributed by: project_config -- {project_root}/_testing
So there appears to be no working way to relocate benchmark output away from the project root: the engines.toml key is overridden, and the CLI flag is only half-applied.
Impact
Minor but confusing — the failure surfaces as a missing-file error naming a path the user never expected a plan to be written to, several layers from the actual cause. The workaround is simply to not pass --output-dir and accept {project_root}/_testing.
Suggested fix
Apply the resolved output directory consistently across plan, run, stamp and report — or, if the plan location is deliberately fixed to the project root, have the run stage load the plan from that same resolved location rather than from --output-dir.
Environment
simready-benchmark 2026.6.5, simready-benchmark-engine-kit 2026.6.5, Isaac Sim 6.0.1, Windows 11, Python 3.12.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the simready-benchmark CLI entry point and trace how the resolved output_dir is passed through the plan and run stages; reproduce with --output-dir and inspect --show-config. Ensure the selected output directory is used consistently by plan, run, stamp, and report, then verify that plan.json is created and loaded from the same location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100