sim-cli-core 0.3.9__tar.gz → 0.4.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/.gitignore +1 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/LICENSE +1 -1
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/NOTICE +1 -1
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/PKG-INFO +26 -99
- sim_cli_core-0.4.1/README.md +120 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/pyproject.toml +15 -3
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/_plugin_install.py +1 -1
- sim_cli_core-0.4.1/src/sim/_skills/external-solver-discovery/LICENSE +21 -0
- sim_cli_core-0.4.1/src/sim/_skills/external-solver-discovery/SKILL.md +145 -0
- sim_cli_core-0.4.1/src/sim/_skills/external-solver-discovery/provenance.json +7 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/_skills/sim-cli/SKILL.md +9 -9
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/_skills/sim-cli/gui/SKILL.md +1 -1
- sim_cli_core-0.3.9/.github/workflows/publish.yml +0 -46
- sim_cli_core-0.3.9/CLAUDE.md +0 -238
- sim_cli_core-0.3.9/CONTRIBUTING.md +0 -25
- sim_cli_core-0.3.9/README.md +0 -193
- sim_cli_core-0.3.9/assets/architecture.svg +0 -89
- sim_cli_core-0.3.9/assets/banner.svg +0 -70
- sim_cli_core-0.3.9/assets/logo.svg +0 -22
- sim_cli_core-0.3.9/docs/DEVELOPMENT.md +0 -116
- sim_cli_core-0.3.9/docs/agent-readability.md +0 -195
- sim_cli_core-0.3.9/docs/architecture/multi-session-and-config.md +0 -204
- sim_cli_core-0.3.9/docs/architecture/skills-layering-plan.md +0 -68
- sim_cli_core-0.3.9/docs/architecture/version-compat.md +0 -148
- sim_cli_core-0.3.9/docs/plugin-install.md +0 -202
- sim_cli_core-0.3.9/docs/remote-solvers.md +0 -49
- sim_cli_core-0.3.9/docs/why-cli-first.md +0 -18
- sim_cli_core-0.3.9/tests/__init__.py +0 -0
- sim_cli_core-0.3.9/tests/base/__init__.py +0 -0
- sim_cli_core-0.3.9/tests/base/test_cli.py +0 -234
- sim_cli_core-0.3.9/tests/base/test_compat.py +0 -373
- sim_cli_core-0.3.9/tests/base/test_config.py +0 -122
- sim_cli_core-0.3.9/tests/base/test_connect.py +0 -26
- sim_cli_core-0.3.9/tests/base/test_describe.py +0 -184
- sim_cli_core-0.3.9/tests/base/test_driver_discovery.py +0 -135
- sim_cli_core-0.3.9/tests/base/test_history.py +0 -98
- sim_cli_core-0.3.9/tests/base/test_init_setup.py +0 -204
- sim_cli_core-0.3.9/tests/base/test_lint.py +0 -49
- sim_cli_core-0.3.9/tests/base/test_lint_public_corpus.py +0 -159
- sim_cli_core-0.3.9/tests/base/test_logs.py +0 -100
- sim_cli_core-0.3.9/tests/base/test_multi_session.py +0 -233
- sim_cli_core-0.3.9/tests/base/test_plugin_install.py +0 -92
- sim_cli_core-0.3.9/tests/base/test_plugins.py +0 -159
- sim_cli_core-0.3.9/tests/base/test_protocol_conformance.py +0 -212
- sim_cli_core-0.3.9/tests/base/test_python_floor_audit.py +0 -127
- sim_cli_core-0.3.9/tests/base/test_run.py +0 -127
- sim_cli_core-0.3.9/tests/base/test_scan.py +0 -194
- sim_cli_core-0.3.9/tests/base/test_session_versions.py +0 -158
- sim_cli_core-0.3.9/tests/conftest.py +0 -131
- sim_cli_core-0.3.9/tests/drivers/__init__.py +0 -0
- sim_cli_core-0.3.9/tests/execution/calculix_e2e_cantilever_run.py +0 -163
- sim_cli_core-0.3.9/tests/execution/coolprop/water_props.py +0 -33
- sim_cli_core-0.3.9/tests/execution/elmer_e2e_heat_square.py +0 -171
- sim_cli_core-0.3.9/tests/execution/gmsh_e2e_sphere_mesh.py +0 -131
- sim_cli_core-0.3.9/tests/execution/lammps_e2e_lj_nvt.py +0 -159
- sim_cli_core-0.3.9/tests/execution/meshio_e2e_gmsh_to_vtk.py +0 -105
- sim_cli_core-0.3.9/tests/execution/pymfem_e2e_poisson.py +0 -78
- sim_cli_core-0.3.9/tests/execution/pyvista_e2e_sphere_stats.py +0 -109
- sim_cli_core-0.3.9/tests/execution/scikit_fem_e2e_poisson.py +0 -60
- sim_cli_core-0.3.9/tests/execution/scikitrf/short_load.py +0 -32
- sim_cli_core-0.3.9/tests/execution/su2_e2e_inviscid_bump.py +0 -113
- sim_cli_core-0.3.9/tests/fixtures/comsol/comsol_good.py +0 -12
- sim_cli_core-0.3.9/tests/fixtures/comsol/comsol_no_client.py +0 -4
- sim_cli_core-0.3.9/tests/fixtures/comsol/comsol_no_import.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/hypermesh_good.py +0 -13
- sim_cli_core-0.3.9/tests/fixtures/hypermesh_gui.py +0 -7
- sim_cli_core-0.3.9/tests/fixtures/hypermesh_no_import.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/hypermesh_no_usage.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/hypermesh_syntax_error.py +0 -4
- sim_cli_core-0.3.9/tests/fixtures/isaac/bad_import_order.py +0 -5
- sim_cli_core-0.3.9/tests/fixtures/isaac/bad_no_close.py +0 -4
- sim_cli_core-0.3.9/tests/fixtures/isaac/bad_no_simapp.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/isaac/hello_world.py +0 -51
- sim_cli_core-0.3.9/tests/fixtures/isaac/import_franka.py +0 -34
- sim_cli_core-0.3.9/tests/fixtures/isaac/not_isaac.py +0 -2
- sim_cli_core-0.3.9/tests/fixtures/isaac/official_hello_world.py +0 -50
- sim_cli_core-0.3.9/tests/fixtures/isaac/replicator_cubes.py +0 -57
- sim_cli_core-0.3.9/tests/fixtures/isaac/syntax_error.py +0 -2
- sim_cli_core-0.3.9/tests/fixtures/isaac/warehouse_sdg.py +0 -50
- sim_cli_core-0.3.9/tests/fixtures/matlab/empty_model.mdl +0 -0
- sim_cli_core-0.3.9/tests/fixtures/matlab/empty_model.slx +0 -0
- sim_cli_core-0.3.9/tests/fixtures/matlab/matlab_ok.m +0 -2
- sim_cli_core-0.3.9/tests/fixtures/mfem_good.py +0 -14
- sim_cli_core-0.3.9/tests/fixtures/mfem_no_import.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/mfem_no_mesh.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/mfem_syntax_error.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/mock_fail.py +0 -5
- sim_cli_core-0.3.9/tests/fixtures/mock_solver.py +0 -6
- sim_cli_core-0.3.9/tests/fixtures/newton/basic_pendulum.json +0 -34
- sim_cli_core-0.3.9/tests/fixtures/newton/cable_twist.py +0 -75
- sim_cli_core-0.3.9/tests/fixtures/newton/robot_g1.json +0 -42
- sim_cli_core-0.3.9/tests/fixtures/not_simulation.py +0 -2
- sim_cli_core-0.3.9/tests/fixtures/pybamm/pybamm_bad_import.py +0 -4
- sim_cli_core-0.3.9/tests/fixtures/pybamm/pybamm_crate_sweep.py +0 -43
- sim_cli_core-0.3.9/tests/fixtures/pybamm/pybamm_no_solve.py +0 -6
- sim_cli_core-0.3.9/tests/fixtures/pybamm/pybamm_spm_good.py +0 -47
- sim_cli_core-0.3.9/tests/fixtures/skfem_good.py +0 -22
- sim_cli_core-0.3.9/tests/fixtures/skfem_no_import.py +0 -3
- sim_cli_core-0.3.9/tests/fixtures/skfem_no_solve.py +0 -6
- sim_cli_core-0.3.9/tests/fixtures/skfem_syntax_error.py +0 -3
- sim_cli_core-0.3.9/tests/gui/__init__.py +0 -0
- sim_cli_core-0.3.9/tests/gui/test_connect_tools_field.py +0 -91
- sim_cli_core-0.3.9/tests/gui/test_gui_facade.py +0 -164
- sim_cli_core-0.3.9/tests/inspect/__init__.py +0 -0
- sim_cli_core-0.3.9/tests/inspect/_extract_comsol_Tmax.py +0 -81
- sim_cli_core-0.3.9/tests/inspect/test_channel_3_4_5_9.py +0 -401
- sim_cli_core-0.3.9/tests/inspect/test_gui_probes.py +0 -331
- sim_cli_core-0.3.9/tests/inspect/test_inspect_types.py +0 -164
- sim_cli_core-0.3.9/tests/inspect/test_probes.py +0 -244
- sim_cli_core-0.3.9/tests/inspect/test_snippet_timeout.py +0 -110
- sim_cli_core-0.3.9/tools/audit_python_floor.py +0 -339
- sim_cli_core-0.3.9/tools/extract_driver.py +0 -598
- sim_cli_core-0.3.9/tools/lint-public-corpus.py +0 -279
- sim_cli_core-0.3.9/uv.lock +0 -859
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/__init__.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/__main__.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/_skills/sim-cli/gui/snippets/dismiss_named_dialog.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/_timeout.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/assets.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/cli.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/compat.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/config.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/describe.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/driver.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/drivers/__init__.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/gui/__init__.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/gui/_pywinauto_tools.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/gui/_win32_dialog.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/history.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/inspect.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/plugins.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/runner.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/server.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/session.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/testing/__init__.py +0 -0
- {sim_cli_core-0.3.9 → sim_cli_core-0.4.1}/src/sim/testing/protocol_conformance.py +0 -0
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: sim-cli-core
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.4.1
|
|
4
4
|
Summary: Agent-native simulation asset parsing and CAD/CAE runtime
|
|
5
5
|
Project-URL: Homepage, https://github.com/svd-ai-lab/sim-cli
|
|
6
6
|
Project-URL: Repository, https://github.com/svd-ai-lab/sim-cli
|
|
7
7
|
Project-URL: Issues, https://github.com/svd-ai-lab/sim-cli/issues
|
|
8
8
|
Project-URL: Documentation, https://github.com/svd-ai-lab/sim-cli#readme
|
|
9
9
|
Project-URL: Changelog, https://github.com/svd-ai-lab/sim-cli/blob/main/CHANGELOG.md
|
|
10
|
-
Author
|
|
10
|
+
Author: SVD Lab
|
|
11
11
|
License-Expression: Apache-2.0
|
|
12
12
|
License-File: LICENSE
|
|
13
13
|
License-File: NOTICE
|
|
14
|
-
Keywords: agent,agentic,cad,cae,cfd,fea,llm,
|
|
14
|
+
Keywords: agent,agentic,cad,cae,cae-files,cfd,fea,llm,parsing,simulation
|
|
15
15
|
Classifier: Development Status :: 3 - Alpha
|
|
16
16
|
Classifier: Intended Audience :: Developers
|
|
17
17
|
Classifier: Intended Audience :: Science/Research
|
|
@@ -43,9 +43,7 @@ Description-Content-Type: text/markdown
|
|
|
43
43
|
# sim
|
|
44
44
|
|
|
45
45
|
**`sim` reads existing CAE files and turns them into structured text an agent
|
|
46
|
-
can use — without launching the solver.**
|
|
47
|
-
validates scripts before you run them, and can hold a live solver session open
|
|
48
|
-
when an agent needs to work one verified step at a time.
|
|
46
|
+
can use — without launching the solver.**
|
|
49
47
|
|
|
50
48
|
Python 3.10+ · Apache-2.0 · alpha
|
|
51
49
|
|
|
@@ -55,8 +53,8 @@ Python 3.10+ · Apache-2.0 · alpha
|
|
|
55
53
|
|
|
56
54
|
Point `sim scan` at a folder of `.mph` / `.inp` / `.cas.h5` / `.aedt` files and
|
|
57
55
|
get back structured JSON an agent can reason over — model inventory, materials,
|
|
58
|
-
boundary conditions, mesh counts, solve settings. No solver, no license, and
|
|
59
|
-
|
|
56
|
+
boundary conditions, mesh counts, solve settings. No solver, no license, and
|
|
57
|
+
nothing else to install:
|
|
60
58
|
|
|
61
59
|
```bash
|
|
62
60
|
uv init # only if this is not already a uv project
|
|
@@ -98,6 +96,8 @@ roll-up `summary` block.)
|
|
|
98
96
|
| Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
|
|
99
97
|
| Icepak Classic | `.tzr` | `icepak-tzr` |
|
|
100
98
|
| Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
|
|
99
|
+
| Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
|
|
100
|
+
| MATLAB data | `.mat` | `matlab-mat` |
|
|
101
101
|
|
|
102
102
|
The default view is bounded — lists come back as `{total, sample, truncated}`
|
|
103
103
|
so a large scan cannot blow up an agent's context — and absolute paths are
|
|
@@ -105,6 +105,10 @@ redacted unless `--include-paths` is set. Use `--full` for the complete parser
|
|
|
105
105
|
result on a small input set, `--limit` and `--no-recursive` to bound a directory
|
|
106
106
|
walk, and `--format` to force a format for an explicitly named file.
|
|
107
107
|
|
|
108
|
+
Every command takes `--json` and returns a stable envelope with a closed
|
|
109
|
+
error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
|
|
110
|
+
Run `uv run sim --json describe` for a machine-readable command manifest.
|
|
111
|
+
|
|
108
112
|
## Example: what's in this folder?
|
|
109
113
|
|
|
110
114
|
```text
|
|
@@ -113,99 +117,22 @@ studies, which already have solved results, and what total power each one
|
|
|
113
117
|
assumes. Use `uv run sim --json scan`.
|
|
114
118
|
```
|
|
115
119
|
|
|
116
|
-
##
|
|
120
|
+
## Optional: working with a local solver
|
|
117
121
|
|
|
118
|
-
|
|
122
|
+
Scanning never needs a solver. If an agent also has to detect solver installs,
|
|
123
|
+
lint a script before running it, or keep a solver session open, add that
|
|
124
|
+
solver's package (for example `sim-plugin-comsol`) and its agent skill:
|
|
119
125
|
|
|
120
126
|
```bash
|
|
121
127
|
uv add sim-plugin-comsol
|
|
122
|
-
uv run sim plugin sync-skills --target .agents/skills --copy
|
|
123
|
-
uv run sim check comsol
|
|
124
|
-
uv run sim plugin doctor comsol --deep # plugin wiring + solver detection
|
|
125
|
-
uv run sim lint <script> # validate before running
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
Use `.agents/skills` for Codex and GitHub Copilot, `.claude/skills` for Claude
|
|
129
|
-
Code. Two things are worth telling the agent explicitly: run through the project
|
|
130
|
-
with `uv run sim ...` so it sees the project's installed plugins, and never
|
|
131
|
-
guess solver API names — inspect the live model or the solver's local docs
|
|
132
|
-
first.
|
|
133
|
-
|
|
134
|
-
No uv, or installing from a wheel, git, or a local checkout — and the `sim.toml`
|
|
135
|
-
project manifest schema — are covered in
|
|
136
|
-
[docs/plugin-install.md](docs/plugin-install.md).
|
|
137
|
-
|
|
138
|
-
## Drive a live solver session
|
|
139
|
-
|
|
140
|
-
When an agent needs the solver held open across steps, `sim connect` starts a
|
|
141
|
-
local runtime and keeps the session alive. A bounded step is one modeling,
|
|
142
|
-
meshing, solving, or postprocessing action that can be inspected and verified
|
|
143
|
-
before continuing: create a geometry feature, assign a material, generate a
|
|
144
|
-
mesh, run one study, extract a probe value, export a result table.
|
|
145
|
-
|
|
146
|
-
Prefer this loop over one large generated script:
|
|
147
|
-
|
|
148
|
-
1. `uv run sim check <solver>`, then `uv run sim connect --solver <solver>`
|
|
149
|
-
2. `uv run sim inspect session.versions` before changing state — including after
|
|
150
|
-
any human GUI edit, since an engineer can cut in through the solver GUI at
|
|
151
|
-
any time and a previous script may no longer match the real session
|
|
152
|
-
3. `uv run sim exec --file step.py --label <step>` — one bounded step
|
|
153
|
-
4. `uv run sim inspect last.result`, verify with numeric evidence (mesh
|
|
154
|
-
statistics, convergence, probes, conservation checks, tolerances), checkpoint
|
|
155
|
-
5. `uv run sim disconnect`, then `uv run sim stop` to free the local runtime
|
|
156
|
-
|
|
157
|
-
The bundled solver skill enforces the details, so give the agent the engineering
|
|
158
|
-
goal in plain language rather than a list of `sim` sub-steps:
|
|
159
|
-
|
|
160
|
-
```text
|
|
161
|
-
Simulate the natural-convection cooling of the attached `pcb.mph` and report the
|
|
162
|
-
maximum junction temperature. Use the installed COMSOL skill. If you need a
|
|
163
|
-
visible COMSOL Desktop session, connect with `--ui-mode gui`.
|
|
128
|
+
uv run sim plugin sync-skills --target .agents/skills --copy # .claude/skills for Claude Code
|
|
129
|
+
uv run sim check comsol
|
|
164
130
|
```
|
|
165
131
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
Solver knowledge is not in the core CLI. It comes from plugins, each of which
|
|
172
|
-
provides a **driver**, so `sim` can launch or talk to the solver, and a
|
|
173
|
-
**skill**, so the agent knows that solver's workflow, pitfalls, and inspection
|
|
174
|
-
rules.
|
|
175
|
-
|
|
176
|
-
| Solver | Package spec | Plugin repo |
|
|
177
|
-
| --- | --- | --- |
|
|
178
|
-
| COMSOL | `sim-plugin-comsol` | [sim-plugin-comsol](https://github.com/svd-ai-lab/sim-plugin-comsol) |
|
|
179
|
-
| Abaqus | `sim-plugin-abaqus` | [sim-plugin-abaqus](https://github.com/svd-ai-lab/sim-plugin-abaqus) |
|
|
180
|
-
| LTspice | `sim-plugin-ltspice` | [sim-plugin-ltspice](https://github.com/svd-ai-lab/sim-plugin-ltspice) |
|
|
181
|
-
|
|
182
|
-
For the curated full list, see
|
|
183
|
-
[sim-plugin-index](https://github.com/svd-ai-lab/sim-plugin-index).
|
|
184
|
-
|
|
185
|
-
## Commands
|
|
186
|
-
|
|
187
|
-
Every command takes `--json` and returns a stable envelope with a closed
|
|
188
|
-
error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
|
|
189
|
-
|
|
190
|
-
| Command | Use it for |
|
|
191
|
-
|---|---|
|
|
192
|
-
| `uv run sim --json scan <path>...` | Parse historical simulation assets without launching a solver. |
|
|
193
|
-
| `uv run sim plugin list` | Show plugins visible in this project environment. |
|
|
194
|
-
| `uv run sim plugin info <solver>` | Show plugin metadata and compatibility summary. |
|
|
195
|
-
| `uv run sim plugin doctor <solver> --deep` | Check plugin wiring plus local solver detection. |
|
|
196
|
-
| `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for your agent. |
|
|
197
|
-
| `uv run sim check <solver>` | Detect local or remote solver installs. |
|
|
198
|
-
| `uv run sim connect --solver <solver>` | Open a persistent solver session. |
|
|
199
|
-
| `uv run sim exec --file step.py` | Run one bounded step in the live session. |
|
|
200
|
-
| `uv run sim inspect <target>` | Query session, result, or solver-specific state. |
|
|
201
|
-
| `uv run sim run script.py --solver <solver>` | Run a deterministic one-shot script. |
|
|
202
|
-
| `uv run sim logs last --field <name>` | Read back a one-shot run's parsed result. |
|
|
203
|
-
| `uv run sim disconnect` | Tear down the active session. |
|
|
204
|
-
| `uv run sim stop` | Stop the local runtime that `sim connect` auto-started. |
|
|
205
|
-
| `uv run sim setup` | Validate `sim.toml` and report declared plugin package specs. |
|
|
206
|
-
|
|
207
|
-
Run `uv run sim --json describe` for a machine-readable command manifest, or
|
|
208
|
-
`uv run sim <command> --help` for exact options.
|
|
132
|
+
The supported solvers, install commands, live-session commands, and the
|
|
133
|
+
`sim.toml` manifest are covered in
|
|
134
|
+
[docs/plugin-install.md](docs/plugin-install.md). Running the solver on another
|
|
135
|
+
host is covered in [docs/remote-solvers.md](docs/remote-solvers.md).
|
|
209
136
|
|
|
210
137
|
## Solver ownership
|
|
211
138
|
|
|
@@ -221,12 +148,12 @@ names remain the property of their respective owners.
|
|
|
221
148
|
|
|
222
149
|
- [docs/agent-readability.md](docs/agent-readability.md) — `--json` envelope,
|
|
223
150
|
error-code enum, exit codes. Read this first if you are an agent.
|
|
224
|
-
- [docs/
|
|
225
|
-
|
|
226
|
-
- [docs/plugin-install.md](docs/plugin-install.md) — plugin installation and
|
|
227
|
-
`sim.toml` reference
|
|
151
|
+
- [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages,
|
|
152
|
+
live sessions, and the `sim.toml` reference
|
|
228
153
|
- [docs/remote-solvers.md](docs/remote-solvers.md) — running the solver on
|
|
229
154
|
another host, and the security constraints that apply
|
|
155
|
+
- [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) — project setup, layout, driver
|
|
156
|
+
protocol, and architecture notes
|
|
230
157
|
- [docs/why-cli-first.md](docs/why-cli-first.md) — why a CLI rather than MCP
|
|
231
158
|
- [CONTRIBUTING.md](CONTRIBUTING.md) — branch, test, and PR workflow
|
|
232
159
|
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# sim
|
|
2
|
+
|
|
3
|
+
**`sim` reads existing CAE files and turns them into structured text an agent
|
|
4
|
+
can use — without launching the solver.**
|
|
5
|
+
|
|
6
|
+
Python 3.10+ · Apache-2.0 · alpha
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Scan existing simulation assets
|
|
11
|
+
|
|
12
|
+
Point `sim scan` at a folder of `.mph` / `.inp` / `.cas.h5` / `.aedt` files and
|
|
13
|
+
get back structured JSON an agent can reason over — model inventory, materials,
|
|
14
|
+
boundary conditions, mesh counts, solve settings. No solver, no license, and
|
|
15
|
+
nothing else to install:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
uv init # only if this is not already a uv project
|
|
19
|
+
uv add sim-cli-core
|
|
20
|
+
uv run sim --json scan ./historical-cases
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```console
|
|
24
|
+
$ uv run sim --json scan ./cases/beam.inp --full
|
|
25
|
+
{
|
|
26
|
+
"schema_version": "sim.scan/v1",
|
|
27
|
+
"assets": [{
|
|
28
|
+
"file_name": "beam.inp",
|
|
29
|
+
"format": "abaqus-inp",
|
|
30
|
+
"summary": {"data": {
|
|
31
|
+
"title": "Cantilever beam thermal-stress",
|
|
32
|
+
"node_count": 3,
|
|
33
|
+
"element_count": 1,
|
|
34
|
+
"materials": ["STEEL"],
|
|
35
|
+
"sections": ["SOLID SECTION:STEEL"],
|
|
36
|
+
"steps": ["STATIC"],
|
|
37
|
+
"boundary_keywords": ["BOUNDARY"],
|
|
38
|
+
"load_keywords": ["CLOAD"],
|
|
39
|
+
"output_keywords": ["NODE PRINT"]
|
|
40
|
+
}}
|
|
41
|
+
}]
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
(abridged — the real envelope also carries `ok`, `engine`, `request`, and a
|
|
46
|
+
roll-up `summary` block.)
|
|
47
|
+
|
|
48
|
+
| Solver | Files | `--format` id |
|
|
49
|
+
| --- | --- | --- |
|
|
50
|
+
| COMSOL | `.mph` | `comsol-mph` |
|
|
51
|
+
| Abaqus | `.inp`, `.inc` | `abaqus-inp` |
|
|
52
|
+
| Fluent | `.cas.h5`, `.msh.h5` | `fluent-hdf5` |
|
|
53
|
+
| Ansys Electronics Desktop (HFSS / Icepak) | `.aedt`, `.aedtz` | `hfss-aedt` |
|
|
54
|
+
| Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
|
|
55
|
+
| Icepak Classic | `.tzr` | `icepak-tzr` |
|
|
56
|
+
| Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
|
|
57
|
+
| Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
|
|
58
|
+
| MATLAB data | `.mat` | `matlab-mat` |
|
|
59
|
+
|
|
60
|
+
The default view is bounded — lists come back as `{total, sample, truncated}`
|
|
61
|
+
so a large scan cannot blow up an agent's context — and absolute paths are
|
|
62
|
+
redacted unless `--include-paths` is set. Use `--full` for the complete parser
|
|
63
|
+
result on a small input set, `--limit` and `--no-recursive` to bound a directory
|
|
64
|
+
walk, and `--format` to force a format for an explicitly named file.
|
|
65
|
+
|
|
66
|
+
Every command takes `--json` and returns a stable envelope with a closed
|
|
67
|
+
error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
|
|
68
|
+
Run `uv run sim --json describe` for a machine-readable command manifest.
|
|
69
|
+
|
|
70
|
+
## Example: what's in this folder?
|
|
71
|
+
|
|
72
|
+
```text
|
|
73
|
+
Scan ./legacy-cases and tell me which models are package-level thermal
|
|
74
|
+
studies, which already have solved results, and what total power each one
|
|
75
|
+
assumes. Use `uv run sim --json scan`.
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Optional: working with a local solver
|
|
79
|
+
|
|
80
|
+
Scanning never needs a solver. If an agent also has to detect solver installs,
|
|
81
|
+
lint a script before running it, or keep a solver session open, add that
|
|
82
|
+
solver's package (for example `sim-plugin-comsol`) and its agent skill:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
uv add sim-plugin-comsol
|
|
86
|
+
uv run sim plugin sync-skills --target .agents/skills --copy # .claude/skills for Claude Code
|
|
87
|
+
uv run sim check comsol
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
The supported solvers, install commands, live-session commands, and the
|
|
91
|
+
`sim.toml` manifest are covered in
|
|
92
|
+
[docs/plugin-install.md](docs/plugin-install.md). Running the solver on another
|
|
93
|
+
host is covered in [docs/remote-solvers.md](docs/remote-solvers.md).
|
|
94
|
+
|
|
95
|
+
## Solver ownership
|
|
96
|
+
|
|
97
|
+
`sim-cli` does not bundle or redistribute simulation solvers or vendor SDKs.
|
|
98
|
+
Install and operate each underlying solver according to its vendor terms. See
|
|
99
|
+
[NOTICE](NOTICE) for optional SDK dependency notes.
|
|
100
|
+
|
|
101
|
+
`sim-cli` is an independent open-source project and is not affiliated with,
|
|
102
|
+
endorsed by, or sponsored by any solver vendor. Product, solver, and company
|
|
103
|
+
names remain the property of their respective owners.
|
|
104
|
+
|
|
105
|
+
## Docs
|
|
106
|
+
|
|
107
|
+
- [docs/agent-readability.md](docs/agent-readability.md) — `--json` envelope,
|
|
108
|
+
error-code enum, exit codes. Read this first if you are an agent.
|
|
109
|
+
- [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages,
|
|
110
|
+
live sessions, and the `sim.toml` reference
|
|
111
|
+
- [docs/remote-solvers.md](docs/remote-solvers.md) — running the solver on
|
|
112
|
+
another host, and the security constraints that apply
|
|
113
|
+
- [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) — project setup, layout, driver
|
|
114
|
+
protocol, and architecture notes
|
|
115
|
+
- [docs/why-cli-first.md](docs/why-cli-first.md) — why a CLI rather than MCP
|
|
116
|
+
- [CONTRIBUTING.md](CONTRIBUTING.md) — branch, test, and PR workflow
|
|
117
|
+
|
|
118
|
+
## License
|
|
119
|
+
|
|
120
|
+
Apache-2.0 — see [LICENSE](LICENSE).
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "sim-cli-core"
|
|
3
|
-
version = "0.
|
|
3
|
+
version = "0.4.1"
|
|
4
4
|
description = "Agent-native simulation asset parsing and CAD/CAE runtime"
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
license = "Apache-2.0"
|
|
7
7
|
requires-python = ">=3.10"
|
|
8
|
-
authors = [{ name = "
|
|
8
|
+
authors = [{ name = "SVD Lab" }]
|
|
9
9
|
keywords = [
|
|
10
10
|
"simulation", "cae", "cad", "cfd", "fea",
|
|
11
11
|
"llm", "agent", "agentic",
|
|
12
|
-
"
|
|
12
|
+
"parsing", "cae-files",
|
|
13
13
|
]
|
|
14
14
|
classifiers = [
|
|
15
15
|
"Development Status :: 3 - Alpha",
|
|
@@ -46,6 +46,9 @@ dependencies = [
|
|
|
46
46
|
[project.optional-dependencies]
|
|
47
47
|
dev = ["pytest>=8.0", "ruff>=0.4"]
|
|
48
48
|
|
|
49
|
+
[dependency-groups]
|
|
50
|
+
dev = ["pytest>=8.0", "ruff>=0.4", "build>=1.0", "hatchling>=1.26"]
|
|
51
|
+
|
|
49
52
|
[project.urls]
|
|
50
53
|
Homepage = "https://github.com/svd-ai-lab/sim-cli"
|
|
51
54
|
Repository = "https://github.com/svd-ai-lab/sim-cli"
|
|
@@ -56,6 +59,12 @@ Changelog = "https://github.com/svd-ai-lab/sim-cli/blob/main/CHANGELOG.md"
|
|
|
56
59
|
[project.scripts]
|
|
57
60
|
sim = "sim.cli:main"
|
|
58
61
|
|
|
62
|
+
[tool.uv.workspace]
|
|
63
|
+
members = ["plugins/*"]
|
|
64
|
+
|
|
65
|
+
[tool.uv.sources]
|
|
66
|
+
sim-cli-core = { workspace = true }
|
|
67
|
+
|
|
59
68
|
[build-system]
|
|
60
69
|
requires = ["hatchling"]
|
|
61
70
|
build-backend = "hatchling.build"
|
|
@@ -69,3 +78,6 @@ markers = ["integration: requires solver packages installed"]
|
|
|
69
78
|
|
|
70
79
|
[tool.ruff]
|
|
71
80
|
target-version = "py310"
|
|
81
|
+
|
|
82
|
+
[tool.hatch.build.targets.sdist]
|
|
83
|
+
only-include = ["src/sim", "pyproject.toml", "README.md", "LICENSE", "NOTICE", "CHANGELOG.md"]
|
|
@@ -40,7 +40,7 @@ def _install_migration_message(source: str | None = None) -> str:
|
|
|
40
40
|
return (
|
|
41
41
|
f"{base}\n\n"
|
|
42
42
|
"Short solver names are not package specs. Find the package spec in "
|
|
43
|
-
"
|
|
43
|
+
"the sim-cli workspace plugin-index.json, then run:\n"
|
|
44
44
|
" uv add sim-cli-core <plugin-package-spec>"
|
|
45
45
|
)
|
|
46
46
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 SVD AI Lab
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: external-solver-discovery
|
|
3
|
+
description: "Discover and safely use external ad hoc solver capabilities, third-party skills, plugins, MCP servers, or native APIs when the host app or agent environment does not bundle a first-party solver path. Use for unsupported solver requests such as FDTD, Lumerical, Meep, openEMS, Tidy3D, gprMax, CST Studio Suite, or user-provided external integrations."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# External Solver Discovery
|
|
7
|
+
|
|
8
|
+
Use this skill when a user needs a solver, third-party plugin, MCP server,
|
|
9
|
+
native API, or cloud service that is not already covered by a bundled
|
|
10
|
+
solver-specific skill.
|
|
11
|
+
|
|
12
|
+
This skill is an ad hoc discovery layer. It does not make an external solver
|
|
13
|
+
supported, installed, licensed, authenticated, or available. It helps the agent
|
|
14
|
+
find credible local or user-configured routes and report evidence honestly.
|
|
15
|
+
|
|
16
|
+
## Required Protocol
|
|
17
|
+
|
|
18
|
+
1. Name the requested capability and distinguish it from bundled solver support.
|
|
19
|
+
For example, HFSS support is 3D EM support, not FDTD support.
|
|
20
|
+
2. Check the current runtime before network-dependent discovery:
|
|
21
|
+
- attached files and workspace extensions
|
|
22
|
+
- project package files and scripts
|
|
23
|
+
- installed commands, environment variables, registry/app paths, and common
|
|
24
|
+
application locations
|
|
25
|
+
- visible skills, plugins, MCP tools, connector tools, and native APIs
|
|
26
|
+
- user-provided licenses, paths, profiles, or account hints
|
|
27
|
+
3. If a third-party skill, plugin, or MCP server is visible, inspect its own
|
|
28
|
+
manifest, README, SKILL file, tool schema, or help output before using it.
|
|
29
|
+
Prefer integrations that expose provenance, version, tool list, and logs.
|
|
30
|
+
4. Do not install packages, enable cloud services, consume a license seat, submit
|
|
31
|
+
jobs, or authenticate accounts without user approval.
|
|
32
|
+
5. Probe the smallest real route first:
|
|
33
|
+
- version or import check
|
|
34
|
+
- open/list a project without solving
|
|
35
|
+
- dry script parse
|
|
36
|
+
- tiny example run
|
|
37
|
+
- MCP health/tool-list call
|
|
38
|
+
6. Treat command success as transport evidence only. Engineering evidence must
|
|
39
|
+
come from solver logs, exported data, result files, convergence, field data,
|
|
40
|
+
S-parameters, or another domain-specific output requested by the user.
|
|
41
|
+
7. If no credible route is available, state exactly what is missing and give the
|
|
42
|
+
narrowest next step, such as a vendor install path, Python environment,
|
|
43
|
+
package install, MCP server command, API key, or license check.
|
|
44
|
+
|
|
45
|
+
## Candidate Selection
|
|
46
|
+
|
|
47
|
+
Prefer the user's already visible capability over installing a new one. Use
|
|
48
|
+
these tie-breakers:
|
|
49
|
+
|
|
50
|
+
- Project-native files first. A `.fsp` or `.lsf` project points to a different
|
|
51
|
+
route than a Python Meep script.
|
|
52
|
+
- Local native APIs before GUI automation when they can expose the required
|
|
53
|
+
state and logs.
|
|
54
|
+
- GUI automation only when the user needs visual operation or the API cannot
|
|
55
|
+
expose the required state.
|
|
56
|
+
- Cloud APIs only when the user confirms account, credentials, data-sensitivity
|
|
57
|
+
constraints, and job-cost expectations.
|
|
58
|
+
- sim-cli solver packages when one exists for the solver and standardized
|
|
59
|
+
checks, session control, or `sim plugin doctor` diagnostics materially reduce
|
|
60
|
+
risk.
|
|
61
|
+
|
|
62
|
+
## FDTD Ad Hoc Checklist
|
|
63
|
+
|
|
64
|
+
The host app or agent environment may not bundle first-party FDTD support. When
|
|
65
|
+
a user asks for FDTD, Lumerical, Meep, openEMS, Tidy3D, gprMax, or files such as
|
|
66
|
+
`.fsp` or `.lsf`, treat the request as external ad hoc discovery.
|
|
67
|
+
|
|
68
|
+
Candidate routes to check:
|
|
69
|
+
|
|
70
|
+
- **Ansys Lumerical FDTD**: Prefer when the user has a licensed install or the
|
|
71
|
+
workspace contains `.fsp` / `.lsf` files. Probe user-provided paths, common
|
|
72
|
+
install locations, and the vendor Python API only after locating a real
|
|
73
|
+
install. Do not attempt to install Lumerical or obtain licenses.
|
|
74
|
+
- **Meep**: Prefer when the project already has Python or Scheme Meep scripts,
|
|
75
|
+
or an open-source scriptable FDTD path is acceptable. Probe the project
|
|
76
|
+
Python/conda/container environment with an import or version check before any
|
|
77
|
+
run. Ask before installing Meep or creating a new environment.
|
|
78
|
+
- **openEMS**: Prefer for RF, microwave, antenna, or PCB-oriented workflows,
|
|
79
|
+
especially when MATLAB/Octave/Python openEMS scripts or CSXCAD references are
|
|
80
|
+
present. Probe MATLAB, Octave, Python, and `PATH` before running examples.
|
|
81
|
+
- **Tidy3D**: Prefer only when the user confirms a Tidy3D account/API
|
|
82
|
+
configuration and cloud submission is acceptable for the project data. Run
|
|
83
|
+
local validation or no-submit construction before uploading or submitting a
|
|
84
|
+
paid/cloud job.
|
|
85
|
+
- **gprMax**: Prefer for ground-penetrating radar or geophysical FDTD problems.
|
|
86
|
+
Probe input files for gprMax directives and run a version/import check before
|
|
87
|
+
any full model.
|
|
88
|
+
|
|
89
|
+
Common project signals include `.fsp`, `.lsf`, `.ctl`, `lumapi`, `import meep`,
|
|
90
|
+
`openEMS`, `CSXCAD`, `InitFDTD`, `RunOpenEMS`, `tidy3d`, `TIDY3D`, `gprMax`,
|
|
91
|
+
`#domain`, `#material`, and `#waveform`.
|
|
92
|
+
|
|
93
|
+
For any FDTD route, collect evidence from the actual tool or API: version or
|
|
94
|
+
install path, opened project or parsed script, run log, mesh/result metadata,
|
|
95
|
+
monitor exports, fields, flux data, S-parameters, HDF5/CSV output, or the
|
|
96
|
+
domain-specific result requested by the user.
|
|
97
|
+
|
|
98
|
+
## CST Third-Party Reference Checklist
|
|
99
|
+
|
|
100
|
+
The host app or agent environment may not bundle first-party CST Studio Suite
|
|
101
|
+
support. The public CAE-Agent-Hub repository can be used as a third-party
|
|
102
|
+
reference when the user explicitly wants a CST MCP route or CST workflow skill:
|
|
103
|
+
|
|
104
|
+
- CST MCP reference:
|
|
105
|
+
`https://github.com/Cai-aa/CAE-Agent-Hub/tree/main/MCP/CST`
|
|
106
|
+
- CST workflow skill reference:
|
|
107
|
+
`https://github.com/Cai-aa/CAE-Agent-Hub/tree/main/Skill/CST/cst-simulation-workflow`
|
|
108
|
+
|
|
109
|
+
Treat these URLs as discovery pointers, not bundled or audited support. Before
|
|
110
|
+
using them:
|
|
111
|
+
|
|
112
|
+
- Check local evidence first: `.cst` projects, CST Studio Suite install paths,
|
|
113
|
+
`CST_INSTALL_ROOT`, visible MCP server registrations, visible skill folders,
|
|
114
|
+
project package files, and user-provided paths or license hints.
|
|
115
|
+
- If CAE-Agent-Hub is present or the user asks to install it, inspect the
|
|
116
|
+
repository README, CST MCP README, CST skill `SKILL.md`, and MCP tool surface
|
|
117
|
+
from that checkout before running tools.
|
|
118
|
+
- Do not clone, install dependencies, register the MCP server, open CST, run a
|
|
119
|
+
solver, or consume a CST license seat without user approval.
|
|
120
|
+
- Prefer a project-local checkout pinned to a tag or commit when installing.
|
|
121
|
+
Avoid presenting a floating third-party `main` checkout as a reproducible
|
|
122
|
+
integration.
|
|
123
|
+
- Verify the MCP transport with a health, detect, or tool-list probe before
|
|
124
|
+
opening projects or invoking CST automation.
|
|
125
|
+
- Work on a copy of any user `.cst` project unless the user explicitly requests
|
|
126
|
+
in-place modification.
|
|
127
|
+
|
|
128
|
+
For CST work, engineering evidence should come from the real CST route: detected
|
|
129
|
+
version or install path, opened project metadata, saved project path, solver log,
|
|
130
|
+
result tree entries, exported S-parameters, Touchstone files, field data,
|
|
131
|
+
far-field or near-field exports, sweep summaries, or the specific result the
|
|
132
|
+
user requested.
|
|
133
|
+
|
|
134
|
+
## Reporting
|
|
135
|
+
|
|
136
|
+
Keep the status crisp:
|
|
137
|
+
|
|
138
|
+
- `verified`: the runtime exposed the tool/API/MCP and a real probe succeeded.
|
|
139
|
+
- `available but unproven`: a likely install or config exists but no probe has
|
|
140
|
+
run yet.
|
|
141
|
+
- `installable`: there is a known package/service route, but it is not present.
|
|
142
|
+
- `blocked`: a required install, license, credential, path, or network route is
|
|
143
|
+
missing.
|
|
144
|
+
|
|
145
|
+
Never describe an ad hoc external route as bundled or first-party support.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: sim-cli
|
|
3
|
-
description: Cross-solver operating discipline for sim-cli workflows — tool choice, input classification, acceptance semantics, and escalation rules that apply across solvers. Use alongside the solver's own
|
|
3
|
+
description: Cross-solver operating discipline for sim-cli workflows — tool choice, input classification, acceptance semantics, and escalation rules that apply across solvers. Use alongside the solver's own skill, which is self-contained for solver-specific work; this skill carries only the shared rules.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# sim-cli
|
|
@@ -11,23 +11,23 @@ tools directly where they are the right primitive. This skill carries the
|
|
|
11
11
|
**cross-solver discipline** — the rules that hold across sim-cli workflows,
|
|
12
12
|
regardless of which solver you drive.
|
|
13
13
|
|
|
14
|
-
The solver
|
|
14
|
+
The **solver skill** is self-contained for solver-specific work:
|
|
15
15
|
solver hard constraints, dependency chains, snippets, workflows, SDK/solver
|
|
16
16
|
notes. It does not depend on loading this skill — but it should stay
|
|
17
17
|
consistent with the discipline below. If a rule applies to more than one
|
|
18
|
-
solver, it belongs here, not in a
|
|
18
|
+
solver, it belongs here, not in a solver skill.
|
|
19
19
|
|
|
20
20
|
---
|
|
21
21
|
|
|
22
22
|
## Execution models
|
|
23
23
|
|
|
24
|
-
The
|
|
24
|
+
The solver skill tells you which model the solver uses. Choose the narrowest
|
|
25
25
|
correct execution primitive; sim-cli is composable, not a universal wrapper.
|
|
26
26
|
|
|
27
27
|
| Model | Used by | Lifecycle |
|
|
28
28
|
|---|---|---|
|
|
29
29
|
| **Persistent session** | Drivers that hold a live process open | `sim connect → sim exec × N → sim inspect → sim disconnect` |
|
|
30
|
-
| **sim-wrapped one-shot batch** |
|
|
30
|
+
| **sim-wrapped one-shot batch** | Driver wrappers that add linting, profile-aware invocation, parsing, history, or safer execution | `sim check → sim run → parse_output/logs → evaluate` |
|
|
31
31
|
| **Native/tool one-shot batch** | Ready solver decks/scripts, vendor batch commands, project pipelines, or post-processing tools where native execution is the right primitive | version/profile probe → native command/script → parse artifacts/logs → evaluate |
|
|
32
32
|
|
|
33
33
|
sim-cli does **not** try to wrap every solver operation, executable flag,
|
|
@@ -39,14 +39,14 @@ the solver's own batch command is the right execution primitive, call that
|
|
|
39
39
|
native command directly instead of forcing it through `sim run`. Preserve
|
|
40
40
|
stdout/stderr, generated files, and acceptance evidence just as carefully.
|
|
41
41
|
|
|
42
|
-
Use `sim run` when the
|
|
42
|
+
Use `sim run` when the solver skill says it is the canonical one-shot path or
|
|
43
43
|
when the wrapper adds real value. Otherwise, keep the sim-cli discipline while
|
|
44
44
|
composing the solver's native tools directly.
|
|
45
45
|
|
|
46
46
|
**The loop, any model:** classify inputs and get the missing Category A values
|
|
47
47
|
from the user (including the acceptance criterion) → choose the execution
|
|
48
48
|
primitive → run a Step-0 version/profile probe (`sim inspect session.versions`
|
|
49
|
-
for persistent sessions; `sim check <solver>`,
|
|
49
|
+
for persistent sessions; `sim check <solver>`, solver-skill guidance, or native
|
|
50
50
|
`--version` / license probe for one-shot work) → execute one bounded step at a
|
|
51
51
|
time → inspect `last.result` or parse the native logs/artifacts between steps →
|
|
52
52
|
evaluate against the acceptance criterion → `sim disconnect` if a persistent
|
|
@@ -63,12 +63,12 @@ session was opened. On any failure, stop and report — do not silently retry.
|
|
|
63
63
|
2. **Step-0 version/profile probe is mandatory.** After `sim connect`, call
|
|
64
64
|
`sim inspect session.versions` and use the returned `profile` /
|
|
65
65
|
`active_sdk_layer` / `active_solver_layer` to pick the right files in the
|
|
66
|
-
|
|
66
|
+
solver skill. Treat `solver_version` as active-runtime evidence only when
|
|
67
67
|
`version_source` is `active_runtime`; a detected installation is not proof
|
|
68
68
|
that the same version was launched. If the runtime version is unreported or
|
|
69
69
|
has no compatible profile, stop before applying version-specific guidance.
|
|
70
70
|
Before `sim run` or native one-shot execution, run the
|
|
71
|
-
relevant probe for that path (`sim check <solver>`,
|
|
71
|
+
relevant probe for that path (`sim check <solver>`, solver-skill guidance, or the
|
|
72
72
|
solver's native `--version` / license check). If a required profile is empty,
|
|
73
73
|
unknown, or deprecated — **stop**.
|
|
74
74
|
3. **Acceptance ≠ exit code.** A `sim run` / `sim exec` / native solver command
|
|
@@ -232,7 +232,7 @@ Things that commonly make `ok` false:
|
|
|
232
232
|
|
|
233
233
|
## Related skills
|
|
234
234
|
|
|
235
|
-
-
|
|
235
|
+
- Solver skills list the dialogs that a given driver is known
|
|
236
236
|
to pop. Check those for recipes before inventing your own.
|
|
237
237
|
- `sim.inspect` probes (issue #8a `window_observed`, #8b screenshots)
|
|
238
238
|
tell you **what is on screen** — read them first, then reach for
|