sim-cli-core 0.4.0__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.4.0 → sim_cli_core-0.4.1}/LICENSE +1 -1
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/NOTICE +1 -1
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/PKG-INFO +24 -101
- sim_cli_core-0.4.1/README.md +120 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/pyproject.toml +3 -3
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/external-solver-discovery/SKILL.md +3 -2
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/sim-cli/SKILL.md +9 -9
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/sim-cli/gui/SKILL.md +1 -1
- sim_cli_core-0.4.0/README.md +0 -197
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/.gitignore +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/__init__.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/__main__.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_plugin_install.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/external-solver-discovery/LICENSE +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/external-solver-discovery/provenance.json +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/sim-cli/gui/snippets/dismiss_named_dialog.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_timeout.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/assets.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/cli.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/compat.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/config.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/describe.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/driver.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/drivers/__init__.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/gui/__init__.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/gui/_pywinauto_tools.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/gui/_win32_dialog.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/history.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/inspect.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/plugins.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/runner.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/server.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/session.py +0 -0
- {sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/testing/__init__.py +0 -0
- {sim_cli_core-0.4.0 → 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.4.
|
|
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
|
|
@@ -107,6 +105,10 @@ redacted unless `--include-paths` is set. Use `--full` for the complete parser
|
|
|
107
105
|
result on a small input set, `--limit` and `--no-recursive` to bound a directory
|
|
108
106
|
walk, and `--format` to force a format for an explicitly named file.
|
|
109
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
|
+
|
|
110
112
|
## Example: what's in this folder?
|
|
111
113
|
|
|
112
114
|
```text
|
|
@@ -115,101 +117,22 @@ studies, which already have solved results, and what total power each one
|
|
|
115
117
|
assumes. Use `uv run sim --json scan`.
|
|
116
118
|
```
|
|
117
119
|
|
|
118
|
-
##
|
|
120
|
+
## Optional: working with a local solver
|
|
119
121
|
|
|
120
|
-
|
|
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:
|
|
121
125
|
|
|
122
126
|
```bash
|
|
123
127
|
uv add sim-plugin-comsol
|
|
124
|
-
uv run sim plugin sync-skills --target .agents/skills --copy
|
|
125
|
-
uv run sim check comsol
|
|
126
|
-
uv run sim plugin doctor comsol --deep # plugin wiring + solver detection
|
|
127
|
-
uv run sim lint <script> # validate before running
|
|
128
|
+
uv run sim plugin sync-skills --target .agents/skills --copy # .claude/skills for Claude Code
|
|
129
|
+
uv run sim check comsol
|
|
128
130
|
```
|
|
129
131
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
first.
|
|
135
|
-
|
|
136
|
-
No uv, or installing from a wheel, git, or a local checkout — and the `sim.toml`
|
|
137
|
-
project manifest schema — are covered in
|
|
138
|
-
[docs/plugin-install.md](docs/plugin-install.md).
|
|
139
|
-
|
|
140
|
-
## Drive a live solver session
|
|
141
|
-
|
|
142
|
-
When an agent needs the solver held open across steps, `sim connect` starts a
|
|
143
|
-
local runtime and keeps the session alive. A bounded step is one modeling,
|
|
144
|
-
meshing, solving, or postprocessing action that can be inspected and verified
|
|
145
|
-
before continuing: create a geometry feature, assign a material, generate a
|
|
146
|
-
mesh, run one study, extract a probe value, export a result table.
|
|
147
|
-
|
|
148
|
-
Prefer this loop over one large generated script:
|
|
149
|
-
|
|
150
|
-
1. `uv run sim check <solver>`, then `uv run sim connect --solver <solver>`
|
|
151
|
-
2. `uv run sim inspect session.versions` before changing state — including after
|
|
152
|
-
any human GUI edit, since an engineer can cut in through the solver GUI at
|
|
153
|
-
any time and a previous script may no longer match the real session
|
|
154
|
-
3. `uv run sim exec --file step.py --label <step>` — one bounded step
|
|
155
|
-
4. `uv run sim inspect last.result`, verify with numeric evidence (mesh
|
|
156
|
-
statistics, convergence, probes, conservation checks, tolerances), checkpoint
|
|
157
|
-
5. `uv run sim disconnect`, then `uv run sim stop` to free the local runtime
|
|
158
|
-
|
|
159
|
-
The bundled solver skill enforces the details, so give the agent the engineering
|
|
160
|
-
goal in plain language rather than a list of `sim` sub-steps:
|
|
161
|
-
|
|
162
|
-
```text
|
|
163
|
-
Simulate the natural-convection cooling of the attached `pcb.mph` and report the
|
|
164
|
-
maximum junction temperature. Use the installed COMSOL skill. If you need a
|
|
165
|
-
visible COMSOL Desktop session, connect with `--ui-mode gui`.
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
Running the solver on a different host — and the security constraints that come
|
|
169
|
-
with it — is covered in [docs/remote-solvers.md](docs/remote-solvers.md).
|
|
170
|
-
|
|
171
|
-
## Solver plugins
|
|
172
|
-
|
|
173
|
-
Solver knowledge is not in the core CLI. It comes from plugins, each of which
|
|
174
|
-
provides a **driver**, so `sim` can launch or talk to the solver, and a
|
|
175
|
-
**skill**, so the agent knows that solver's workflow, pitfalls, and inspection
|
|
176
|
-
rules.
|
|
177
|
-
|
|
178
|
-
Packages and entry points are listed in the [workspace plugin index](plugin-index.json).
|
|
179
|
-
Each plugin remains independently installable from PyPI under its existing
|
|
180
|
-
`sim-plugin-<solver>` name. Its source and bundled skills live in
|
|
181
|
-
[`plugins/<solver>/`](plugins/).
|
|
182
|
-
|
|
183
|
-
For a source install of one plugin:
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
uv add sim-cli-core "sim-plugin-fluent @ git+https://github.com/svd-ai-lab/sim-cli.git#subdirectory=plugins/fluent"
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
## Commands
|
|
190
|
-
|
|
191
|
-
Every command takes `--json` and returns a stable envelope with a closed
|
|
192
|
-
error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
|
|
193
|
-
|
|
194
|
-
| Command | Use it for |
|
|
195
|
-
|---|---|
|
|
196
|
-
| `uv run sim --json scan <path>...` | Parse historical simulation assets without launching a solver. |
|
|
197
|
-
| `uv run sim plugin list` | Show plugins visible in this project environment. |
|
|
198
|
-
| `uv run sim plugin info <solver>` | Show plugin metadata and compatibility summary. |
|
|
199
|
-
| `uv run sim plugin doctor <solver> --deep` | Check plugin wiring plus local solver detection. |
|
|
200
|
-
| `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for your agent. |
|
|
201
|
-
| `uv run sim check <solver>` | Detect local or remote solver installs. |
|
|
202
|
-
| `uv run sim connect --solver <solver>` | Open a persistent solver session. |
|
|
203
|
-
| `uv run sim exec --file step.py` | Run one bounded step in the live session. |
|
|
204
|
-
| `uv run sim inspect <target>` | Query session, result, or solver-specific state. |
|
|
205
|
-
| `uv run sim run script.py --solver <solver>` | Run a deterministic one-shot script. |
|
|
206
|
-
| `uv run sim logs last --field <name>` | Read back a one-shot run's parsed result. |
|
|
207
|
-
| `uv run sim disconnect` | Tear down the active session. |
|
|
208
|
-
| `uv run sim stop` | Stop the local runtime that `sim connect` auto-started. |
|
|
209
|
-
| `uv run sim setup` | Validate `sim.toml` and report declared plugin package specs. |
|
|
210
|
-
|
|
211
|
-
Run `uv run sim --json describe` for a machine-readable command manifest, or
|
|
212
|
-
`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).
|
|
213
136
|
|
|
214
137
|
## Solver ownership
|
|
215
138
|
|
|
@@ -225,12 +148,12 @@ names remain the property of their respective owners.
|
|
|
225
148
|
|
|
226
149
|
- [docs/agent-readability.md](docs/agent-readability.md) — `--json` envelope,
|
|
227
150
|
error-code enum, exit codes. Read this first if you are an agent.
|
|
228
|
-
- [docs/
|
|
229
|
-
|
|
230
|
-
- [docs/plugin-install.md](docs/plugin-install.md) — plugin installation and
|
|
231
|
-
`sim.toml` reference
|
|
151
|
+
- [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages,
|
|
152
|
+
live sessions, and the `sim.toml` reference
|
|
232
153
|
- [docs/remote-solvers.md](docs/remote-solvers.md) — running the solver on
|
|
233
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
|
|
234
157
|
- [docs/why-cli-first.md](docs/why-cli-first.md) — why a CLI rather than MCP
|
|
235
158
|
- [CONTRIBUTING.md](CONTRIBUTING.md) — branch, test, and PR workflow
|
|
236
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.4.
|
|
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",
|
{sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/external-solver-discovery/SKILL.md
RENAMED
|
@@ -55,8 +55,9 @@ these tie-breakers:
|
|
|
55
55
|
expose the required state.
|
|
56
56
|
- Cloud APIs only when the user confirms account, credentials, data-sensitivity
|
|
57
57
|
constraints, and job-cost expectations.
|
|
58
|
-
- sim-cli
|
|
59
|
-
session control, or plugin diagnostics materially reduce
|
|
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.
|
|
60
61
|
|
|
61
62
|
## FDTD Ad Hoc Checklist
|
|
62
63
|
|
|
@@ -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
|
sim_cli_core-0.4.0/README.md
DELETED
|
@@ -1,197 +0,0 @@
|
|
|
1
|
-
# sim
|
|
2
|
-
|
|
3
|
-
**`sim` reads existing CAE files and turns them into structured text an agent
|
|
4
|
-
can use — without launching the solver.** It also detects local solver installs,
|
|
5
|
-
validates scripts before you run them, and can hold a live solver session open
|
|
6
|
-
when an agent needs to work one verified step at a time.
|
|
7
|
-
|
|
8
|
-
Python 3.10+ · Apache-2.0 · alpha
|
|
9
|
-
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
## Scan existing simulation assets
|
|
13
|
-
|
|
14
|
-
Point `sim scan` at a folder of `.mph` / `.inp` / `.cas.h5` / `.aedt` files and
|
|
15
|
-
get back structured JSON an agent can reason over — model inventory, materials,
|
|
16
|
-
boundary conditions, mesh counts, solve settings. No solver, no license, and no
|
|
17
|
-
plugin needed:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
uv init # only if this is not already a uv project
|
|
21
|
-
uv add sim-cli-core
|
|
22
|
-
uv run sim --json scan ./historical-cases
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
```console
|
|
26
|
-
$ uv run sim --json scan ./cases/beam.inp --full
|
|
27
|
-
{
|
|
28
|
-
"schema_version": "sim.scan/v1",
|
|
29
|
-
"assets": [{
|
|
30
|
-
"file_name": "beam.inp",
|
|
31
|
-
"format": "abaqus-inp",
|
|
32
|
-
"summary": {"data": {
|
|
33
|
-
"title": "Cantilever beam thermal-stress",
|
|
34
|
-
"node_count": 3,
|
|
35
|
-
"element_count": 1,
|
|
36
|
-
"materials": ["STEEL"],
|
|
37
|
-
"sections": ["SOLID SECTION:STEEL"],
|
|
38
|
-
"steps": ["STATIC"],
|
|
39
|
-
"boundary_keywords": ["BOUNDARY"],
|
|
40
|
-
"load_keywords": ["CLOAD"],
|
|
41
|
-
"output_keywords": ["NODE PRINT"]
|
|
42
|
-
}}
|
|
43
|
-
}]
|
|
44
|
-
}
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
(abridged — the real envelope also carries `ok`, `engine`, `request`, and a
|
|
48
|
-
roll-up `summary` block.)
|
|
49
|
-
|
|
50
|
-
| Solver | Files | `--format` id |
|
|
51
|
-
| --- | --- | --- |
|
|
52
|
-
| COMSOL | `.mph` | `comsol-mph` |
|
|
53
|
-
| Abaqus | `.inp`, `.inc` | `abaqus-inp` |
|
|
54
|
-
| Fluent | `.cas.h5`, `.msh.h5` | `fluent-hdf5` |
|
|
55
|
-
| Ansys Electronics Desktop (HFSS / Icepak) | `.aedt`, `.aedtz` | `hfss-aedt` |
|
|
56
|
-
| Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
|
|
57
|
-
| Icepak Classic | `.tzr` | `icepak-tzr` |
|
|
58
|
-
| Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
|
|
59
|
-
| Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
|
|
60
|
-
| MATLAB data | `.mat` | `matlab-mat` |
|
|
61
|
-
|
|
62
|
-
The default view is bounded — lists come back as `{total, sample, truncated}`
|
|
63
|
-
so a large scan cannot blow up an agent's context — and absolute paths are
|
|
64
|
-
redacted unless `--include-paths` is set. Use `--full` for the complete parser
|
|
65
|
-
result on a small input set, `--limit` and `--no-recursive` to bound a directory
|
|
66
|
-
walk, and `--format` to force a format for an explicitly named file.
|
|
67
|
-
|
|
68
|
-
## Example: what's in this folder?
|
|
69
|
-
|
|
70
|
-
```text
|
|
71
|
-
Scan ./legacy-cases and tell me which models are package-level thermal
|
|
72
|
-
studies, which already have solved results, and what total power each one
|
|
73
|
-
assumes. Use `uv run sim --json scan`.
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
## Find solvers and validate scripts
|
|
77
|
-
|
|
78
|
-
These need the solver's plugin installed — `sim-cli-core` ships with no drivers:
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
uv add sim-plugin-comsol
|
|
82
|
-
uv run sim plugin sync-skills --target .agents/skills --copy
|
|
83
|
-
uv run sim check comsol # detect local installs and versions
|
|
84
|
-
uv run sim plugin doctor comsol --deep # plugin wiring + solver detection
|
|
85
|
-
uv run sim lint <script> # validate before running
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
Use `.agents/skills` for Codex and GitHub Copilot, `.claude/skills` for Claude
|
|
89
|
-
Code. Two things are worth telling the agent explicitly: run through the project
|
|
90
|
-
with `uv run sim ...` so it sees the project's installed plugins, and never
|
|
91
|
-
guess solver API names — inspect the live model or the solver's local docs
|
|
92
|
-
first.
|
|
93
|
-
|
|
94
|
-
No uv, or installing from a wheel, git, or a local checkout — and the `sim.toml`
|
|
95
|
-
project manifest schema — are covered in
|
|
96
|
-
[docs/plugin-install.md](docs/plugin-install.md).
|
|
97
|
-
|
|
98
|
-
## Drive a live solver session
|
|
99
|
-
|
|
100
|
-
When an agent needs the solver held open across steps, `sim connect` starts a
|
|
101
|
-
local runtime and keeps the session alive. A bounded step is one modeling,
|
|
102
|
-
meshing, solving, or postprocessing action that can be inspected and verified
|
|
103
|
-
before continuing: create a geometry feature, assign a material, generate a
|
|
104
|
-
mesh, run one study, extract a probe value, export a result table.
|
|
105
|
-
|
|
106
|
-
Prefer this loop over one large generated script:
|
|
107
|
-
|
|
108
|
-
1. `uv run sim check <solver>`, then `uv run sim connect --solver <solver>`
|
|
109
|
-
2. `uv run sim inspect session.versions` before changing state — including after
|
|
110
|
-
any human GUI edit, since an engineer can cut in through the solver GUI at
|
|
111
|
-
any time and a previous script may no longer match the real session
|
|
112
|
-
3. `uv run sim exec --file step.py --label <step>` — one bounded step
|
|
113
|
-
4. `uv run sim inspect last.result`, verify with numeric evidence (mesh
|
|
114
|
-
statistics, convergence, probes, conservation checks, tolerances), checkpoint
|
|
115
|
-
5. `uv run sim disconnect`, then `uv run sim stop` to free the local runtime
|
|
116
|
-
|
|
117
|
-
The bundled solver skill enforces the details, so give the agent the engineering
|
|
118
|
-
goal in plain language rather than a list of `sim` sub-steps:
|
|
119
|
-
|
|
120
|
-
```text
|
|
121
|
-
Simulate the natural-convection cooling of the attached `pcb.mph` and report the
|
|
122
|
-
maximum junction temperature. Use the installed COMSOL skill. If you need a
|
|
123
|
-
visible COMSOL Desktop session, connect with `--ui-mode gui`.
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
Running the solver on a different host — and the security constraints that come
|
|
127
|
-
with it — is covered in [docs/remote-solvers.md](docs/remote-solvers.md).
|
|
128
|
-
|
|
129
|
-
## Solver plugins
|
|
130
|
-
|
|
131
|
-
Solver knowledge is not in the core CLI. It comes from plugins, each of which
|
|
132
|
-
provides a **driver**, so `sim` can launch or talk to the solver, and a
|
|
133
|
-
**skill**, so the agent knows that solver's workflow, pitfalls, and inspection
|
|
134
|
-
rules.
|
|
135
|
-
|
|
136
|
-
Packages and entry points are listed in the [workspace plugin index](plugin-index.json).
|
|
137
|
-
Each plugin remains independently installable from PyPI under its existing
|
|
138
|
-
`sim-plugin-<solver>` name. Its source and bundled skills live in
|
|
139
|
-
[`plugins/<solver>/`](plugins/).
|
|
140
|
-
|
|
141
|
-
For a source install of one plugin:
|
|
142
|
-
|
|
143
|
-
```bash
|
|
144
|
-
uv add sim-cli-core "sim-plugin-fluent @ git+https://github.com/svd-ai-lab/sim-cli.git#subdirectory=plugins/fluent"
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
## Commands
|
|
148
|
-
|
|
149
|
-
Every command takes `--json` and returns a stable envelope with a closed
|
|
150
|
-
error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
|
|
151
|
-
|
|
152
|
-
| Command | Use it for |
|
|
153
|
-
|---|---|
|
|
154
|
-
| `uv run sim --json scan <path>...` | Parse historical simulation assets without launching a solver. |
|
|
155
|
-
| `uv run sim plugin list` | Show plugins visible in this project environment. |
|
|
156
|
-
| `uv run sim plugin info <solver>` | Show plugin metadata and compatibility summary. |
|
|
157
|
-
| `uv run sim plugin doctor <solver> --deep` | Check plugin wiring plus local solver detection. |
|
|
158
|
-
| `uv run sim plugin sync-skills --target .agents/skills --copy` | Materialize installed plugin skills for your agent. |
|
|
159
|
-
| `uv run sim check <solver>` | Detect local or remote solver installs. |
|
|
160
|
-
| `uv run sim connect --solver <solver>` | Open a persistent solver session. |
|
|
161
|
-
| `uv run sim exec --file step.py` | Run one bounded step in the live session. |
|
|
162
|
-
| `uv run sim inspect <target>` | Query session, result, or solver-specific state. |
|
|
163
|
-
| `uv run sim run script.py --solver <solver>` | Run a deterministic one-shot script. |
|
|
164
|
-
| `uv run sim logs last --field <name>` | Read back a one-shot run's parsed result. |
|
|
165
|
-
| `uv run sim disconnect` | Tear down the active session. |
|
|
166
|
-
| `uv run sim stop` | Stop the local runtime that `sim connect` auto-started. |
|
|
167
|
-
| `uv run sim setup` | Validate `sim.toml` and report declared plugin package specs. |
|
|
168
|
-
|
|
169
|
-
Run `uv run sim --json describe` for a machine-readable command manifest, or
|
|
170
|
-
`uv run sim <command> --help` for exact options.
|
|
171
|
-
|
|
172
|
-
## Solver ownership
|
|
173
|
-
|
|
174
|
-
`sim-cli` does not bundle or redistribute simulation solvers or vendor SDKs.
|
|
175
|
-
Install and operate each underlying solver according to its vendor terms. See
|
|
176
|
-
[NOTICE](NOTICE) for optional SDK dependency notes.
|
|
177
|
-
|
|
178
|
-
`sim-cli` is an independent open-source project and is not affiliated with,
|
|
179
|
-
endorsed by, or sponsored by any solver vendor. Product, solver, and company
|
|
180
|
-
names remain the property of their respective owners.
|
|
181
|
-
|
|
182
|
-
## Docs
|
|
183
|
-
|
|
184
|
-
- [docs/agent-readability.md](docs/agent-readability.md) — `--json` envelope,
|
|
185
|
-
error-code enum, exit codes. Read this first if you are an agent.
|
|
186
|
-
- [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) — project setup, layout, driver
|
|
187
|
-
protocol, and architecture notes
|
|
188
|
-
- [docs/plugin-install.md](docs/plugin-install.md) — plugin installation and
|
|
189
|
-
`sim.toml` reference
|
|
190
|
-
- [docs/remote-solvers.md](docs/remote-solvers.md) — running the solver on
|
|
191
|
-
another host, and the security constraints that apply
|
|
192
|
-
- [docs/why-cli-first.md](docs/why-cli-first.md) — why a CLI rather than MCP
|
|
193
|
-
- [CONTRIBUTING.md](CONTRIBUTING.md) — branch, test, and PR workflow
|
|
194
|
-
|
|
195
|
-
## License
|
|
196
|
-
|
|
197
|
-
Apache-2.0 — see [LICENSE](LICENSE).
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{sim_cli_core-0.4.0 → sim_cli_core-0.4.1}/src/sim/_skills/external-solver-discovery/provenance.json
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|