os-optics-kit

Tools, engine-reproducible cases and agent skills for OS Optics.

English · 简体中文

os-optics-kit builds on the OS Optics engine. It provides one command, os-optics-kit, with tools that edit Projects by ID, sweep parameters, compare saved runs, plot, report, estimate sensitivity and tolerance, select catalog parts and analyze detector measurements; a collection of cases, designs that rerun on the engine and compare with their recorded outcome; and a vendor-neutral skill page for each tool, which any coding agent can load.

Agent guide · Design studies · Measurements · External tools · Workflow recipes · Contributing

Install

python -m pip install "os-optics[protected]" os-optics-kit
os-optics doctor

Python 3.11 or newer. Plots need the plot extra: python -m pip install "os-optics-kit[plot]". Cases that use catalog components need the catalog: os-optics catalog sync. The engine's installation guide covers virtual environments and upgrades.

Quick start

os-optics-kit skills list
os-optics-kit skills install --dest SKILLS_DIR
os-optics-kit cases list
os-optics-kit cases copy ideal-lens-focus --dest .
os-optics-kit cases verify ideal-lens-focus
cd ideal-lens-focus
os-optics project run project.json --out-dir run
os-optics-kit summary run

skills list prints the skill index as compact JSON; skills install copies the skill pages into the skills directory of your agent host (SKILLS_DIR). The cases ship inside the package, so cases copy and cases verify work without a clone; verify reruns the case and compares the run status and every target assessment with the recorded outcome. os-optics-kit <command> --help describes every command.

Cases

Each case holds project.json (the Project with its targets), CASE.md (for agents), an illustrated README.md and expected.json (the verified outcome), plus its own scripts, study specs or data. See the case format.

Tools and skills

os-optics-kit skills show NAME prints a skill page; skills.json indexes them. Tools are also importable (import os_optics_kit), and python -m os_optics_kit <command> runs the same commands.

Version alignment

os-optics-kit 0.1.x requires os-optics>=0.12,<0.13 and was verified with os-optics 0.12.0 and catalog release 2026-10-28.1 (baseline.json). Each case records the engine and catalog release it was verified with. See case format and engine alignment.

Contributing

Cases, tools, skills and documentation are welcome as pull requests. An agent contributes with the user's own GitHub account: os-optics-kit contrib case and os-optics-kit contrib tool verify the contribution and open the pull request, or stop at a bundle with the patch to submit later. See CONTRIBUTING.md and contributing with an agent. Engine questions and bug reports go to the os-optics issue tracker.

License

os-optics-kit is released under the MIT License. The engine, os-optics, is distributed under its own license.