sim-cli-core 0.3.1__tar.gz → 0.3.3__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.1 → sim_cli_core-0.3.3}/PKG-INFO +28 -32
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/README.md +27 -31
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/DEVELOPMENT.md +2 -1
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/README.zh.md +15 -19
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/agent-readability.md +1 -1
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/plugin-install.md +40 -51
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/pyproject.toml +1 -1
- sim_cli_core-0.3.3/src/sim/_plugin_install.py +352 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/cli.py +56 -12
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/compat.py +1 -1
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/config.py +8 -11
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/describe.py +9 -5
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/history.py +6 -0
- sim_cli_core-0.3.3/src/sim/plugin_catalog.py +232 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_cli.py +4 -4
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_init_setup.py +16 -6
- sim_cli_core-0.3.3/tests/base/test_plugin_catalog.py +137 -0
- sim_cli_core-0.3.3/tests/base/test_plugin_install.py +248 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/conftest.py +7 -1
- sim_cli_core-0.3.1/src/sim/_plugin_install.py +0 -530
- sim_cli_core-0.3.1/tests/base/test_plugin_install.py +0 -459
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/.github/workflows/publish.yml +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/.gitignore +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/CLAUDE.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/CONTRIBUTING.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/LICENSE +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/NOTICE +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/assets/architecture.svg +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/assets/banner.svg +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/assets/logo.svg +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/README.de.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/README.ja.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/architecture/multi-session-and-config.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/architecture/skills-layering-plan.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/docs/architecture/version-compat.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/__main__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/_timeout.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/driver.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/drivers/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/gui/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/gui/_pywinauto_tools.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/gui/_win32_dialog.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/inspect.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/plugins.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/runner.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/server.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/session.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/testing/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/src/sim/testing/protocol_conformance.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_compat.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_config.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_connect.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_describe.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_driver_discovery.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_history.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_lint.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_lint_public_corpus.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_logs.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_multi_session.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_plugins.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_protocol_conformance.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/base/test_run.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/drivers/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/calculix_e2e_cantilever_run.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/coolprop/water_props.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/elmer_e2e_heat_square.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/gmsh_e2e_sphere_mesh.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/lammps_e2e_lj_nvt.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/meshio_e2e_gmsh_to_vtk.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/pymfem_e2e_poisson.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/pyvista_e2e_sphere_stats.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/scikit_fem_e2e_poisson.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/scikitrf/short_load.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/execution/su2_e2e_inviscid_bump.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/comsol/comsol_good.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/comsol/comsol_no_client.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/comsol/comsol_no_import.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/hypermesh_good.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/hypermesh_gui.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/hypermesh_no_import.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/hypermesh_no_usage.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/hypermesh_syntax_error.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/bad_import_order.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/bad_no_close.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/bad_no_simapp.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/hello_world.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/import_franka.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/not_isaac.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/official_hello_world.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/replicator_cubes.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/syntax_error.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/isaac/warehouse_sdg.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/matlab/empty_model.mdl +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/matlab/empty_model.slx +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/matlab/matlab_ok.m +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/mfem_good.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/mfem_no_import.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/mfem_no_mesh.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/mfem_syntax_error.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/mock_fail.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/mock_solver.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/newton/basic_pendulum.json +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/newton/cable_twist.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/newton/robot_g1.json +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/not_simulation.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/pybamm/pybamm_bad_import.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/pybamm/pybamm_crate_sweep.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/pybamm/pybamm_no_solve.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/pybamm/pybamm_spm_good.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/skfem_good.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/skfem_no_import.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/skfem_no_solve.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/fixtures/skfem_syntax_error.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/gui/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/gui/test_connect_tools_field.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/gui/test_gui_facade.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/__init__.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/_extract_comsol_Tmax.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/test_channel_3_4_5_9.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/test_gui_probes.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/test_inspect_types.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/test_probes.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tests/inspect/test_snippet_timeout.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tools/extract_driver.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/tools/lint-public-corpus.py +0 -0
- {sim_cli_core-0.3.1 → sim_cli_core-0.3.3}/uv.lock +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sim-cli-core
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.3
|
|
4
4
|
Summary: Make every engineering tool agent-native — a CLI runtime that lets LLM agents launch, drive, and observe CAD/CAE software
|
|
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
|
|
@@ -123,9 +123,8 @@ Prereq: [`uv`](https://docs.astral.sh/uv/) — install with `curl -LsSf https://
|
|
|
123
123
|
# — no driver choice yet:
|
|
124
124
|
uv pip install sim-cli-core
|
|
125
125
|
|
|
126
|
-
# 2. Install the plugin for the solver you actually want
|
|
127
|
-
|
|
128
|
-
sim plugin install <solver> # e.g. ltspice
|
|
126
|
+
# 2. Install the plugin for the solver you actually want:
|
|
127
|
+
sim plugin install sim-plugin-ltspice
|
|
129
128
|
|
|
130
129
|
# 3. Tell sim to look at this machine and pick the right SDK profile:
|
|
131
130
|
sim check <solver>
|
|
@@ -153,9 +152,8 @@ sim --host <server-ip> disconnect
|
|
|
153
152
|
# — no driver choice yet:
|
|
154
153
|
uv pip install sim-cli-core
|
|
155
154
|
|
|
156
|
-
# 2. Install the plugin for the solver you actually want
|
|
157
|
-
|
|
158
|
-
sim plugin install <solver> # e.g. ltspice
|
|
155
|
+
# 2. Install the plugin for the solver you actually want:
|
|
156
|
+
sim plugin install sim-plugin-ltspice
|
|
159
157
|
|
|
160
158
|
# 3. Tell sim to look at this machine and pick the right SDK profile:
|
|
161
159
|
sim check <solver>
|
|
@@ -186,30 +184,24 @@ That's the full loop: **detect → bootstrap → launch → drive → observe
|
|
|
186
184
|
|
|
187
185
|
---
|
|
188
186
|
|
|
189
|
-
## 📦 Plugin
|
|
187
|
+
## 📦 Plugin sources
|
|
190
188
|
|
|
191
|
-
`sim plugin install <
|
|
189
|
+
`sim plugin install <source>` accepts explicit install sources only:
|
|
192
190
|
|
|
193
|
-
|
|
194
|
-
|
|
191
|
+
- Exact package specs, such as `sim-plugin-ltspice` or `sim-plugin-ltspice==0.2.3`
|
|
192
|
+
- Package specs plus private indexes, such as `sim-plugin-mechanical --extra-index-url https://example.com/simple/`
|
|
193
|
+
- Direct wheel/sdist URLs, such as `https://example.com/sim_plugin_ltspice-0.2.3-py3-none-any.whl`
|
|
194
|
+
- Git URLs, such as `git+https://github.com/<org>/sim-plugin-<name>`
|
|
195
|
+
- Local plugin directories, wheels, and sdists
|
|
195
196
|
|
|
196
|
-
|
|
197
|
+
Discovery is separate from installation:
|
|
197
198
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
{
|
|
202
|
-
"updated": "<ISO date>",
|
|
203
|
-
"plugins": {
|
|
204
|
-
"<name>": {
|
|
205
|
-
"version": "<X.Y.Z>",
|
|
206
|
-
"wheel": "https://cdn.svdailab.com/wheels/<file>.whl"
|
|
207
|
-
}
|
|
208
|
-
}
|
|
209
|
-
}
|
|
199
|
+
```bash
|
|
200
|
+
sim plugin catalog # official plugins (display + copy-paste install string)
|
|
201
|
+
sim plugin list # installed/registered plugins on this machine
|
|
210
202
|
```
|
|
211
203
|
|
|
212
|
-
|
|
204
|
+
Short solver aliases such as `ltspice` are catalogue names, not install sources. Run `sim plugin catalog` to find the recommended install string for each plugin, then pass it to `sim plugin install`.
|
|
213
205
|
|
|
214
206
|
---
|
|
215
207
|
|
|
@@ -219,20 +211,24 @@ To install a wheel directly without going through the resolver, hand `sim plugin
|
|
|
219
211
|
|
|
220
212
|
`sim` is most useful for **GUI-heavy solvers** — COMSOL, ANSYS Mechanical, ANSYS Fluent, MATLAB Simulink, Abaqus, Flotherm — where every agent iteration would otherwise mean clicking through dialog boxes.
|
|
221
213
|
|
|
222
|
-
Install
|
|
214
|
+
Install from a discovered package, then list what is installed locally:
|
|
223
215
|
|
|
224
216
|
```bash
|
|
225
|
-
sim plugin
|
|
226
|
-
sim plugin install
|
|
217
|
+
sim plugin catalog # discover what's available + install strings
|
|
218
|
+
sim plugin install sim-plugin-ltspice
|
|
219
|
+
sim plugin list # show installed plugins
|
|
227
220
|
```
|
|
228
221
|
|
|
229
222
|
Reference implementation to read for shape: [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice).
|
|
230
223
|
|
|
231
|
-
**Private plugins** (vendor-IP-sensitive backends
|
|
224
|
+
**Private plugins** (vendor-IP-sensitive backends) install through explicit URLs, private repos, or private Python indexes — same `sim plugin install` flow:
|
|
232
225
|
|
|
233
226
|
```bash
|
|
234
227
|
sim plugin install git+https://github.com/<org>/sim-plugin-<name>
|
|
235
228
|
# (you need read-access to the repo; without it, git clone returns 401)
|
|
229
|
+
|
|
230
|
+
sim plugin install sim-plugin-mechanical --extra-index-url https://example.com/simple/
|
|
231
|
+
# standard PEP 503/private-index path for commercial wrappers
|
|
236
232
|
```
|
|
237
233
|
|
|
238
234
|
Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
|
|
@@ -250,7 +246,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
|
|
|
250
246
|
### 🔌 Solver-agnostic
|
|
251
247
|
- **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
|
|
252
248
|
- **Persistent + one-shot** from the same CLI — no separate client per mode
|
|
253
|
-
- **Plugin
|
|
249
|
+
- **Plugin discovery + explicit installs** — `sim plugin catalog` discovers available plugins; `sim plugin install` accepts exact package specs, private indexes, direct URLs, git URLs, and local artifacts
|
|
254
250
|
- **Companion skills** in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) so an LLM picks up each new backend without prior context
|
|
255
251
|
|
|
256
252
|
### 🌐 Remote-friendly
|
|
@@ -264,7 +260,8 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
|
|
|
264
260
|
|
|
265
261
|
| Command | What it does | Analogy |
|
|
266
262
|
|---|---|---|
|
|
267
|
-
| `sim plugin
|
|
263
|
+
| `sim plugin catalog` | Discover available solver plugins | `npm search` |
|
|
264
|
+
| `sim plugin list / install / uninstall` | Manage installed plugins from explicit install sources | `npm install` |
|
|
268
265
|
| `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
|
|
269
266
|
| `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
|
|
270
267
|
| `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
|
|
@@ -340,7 +337,6 @@ That is the entire setup — same `sim-cli-core` package on both sides, same wir
|
|
|
340
337
|
|
|
341
338
|
## 🔗 Related projects
|
|
342
339
|
|
|
343
|
-
- **[`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)** — community-maintained plugin catalogue; second of two sources `sim plugin install <name>` resolves against (the first is the svd-maintained manifest at `cdn.svdailab.com/manifest.json`)
|
|
344
340
|
- **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
|
|
345
341
|
- **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
|
|
346
342
|
|
|
@@ -83,9 +83,8 @@ Prereq: [`uv`](https://docs.astral.sh/uv/) — install with `curl -LsSf https://
|
|
|
83
83
|
# — no driver choice yet:
|
|
84
84
|
uv pip install sim-cli-core
|
|
85
85
|
|
|
86
|
-
# 2. Install the plugin for the solver you actually want
|
|
87
|
-
|
|
88
|
-
sim plugin install <solver> # e.g. ltspice
|
|
86
|
+
# 2. Install the plugin for the solver you actually want:
|
|
87
|
+
sim plugin install sim-plugin-ltspice
|
|
89
88
|
|
|
90
89
|
# 3. Tell sim to look at this machine and pick the right SDK profile:
|
|
91
90
|
sim check <solver>
|
|
@@ -113,9 +112,8 @@ sim --host <server-ip> disconnect
|
|
|
113
112
|
# — no driver choice yet:
|
|
114
113
|
uv pip install sim-cli-core
|
|
115
114
|
|
|
116
|
-
# 2. Install the plugin for the solver you actually want
|
|
117
|
-
|
|
118
|
-
sim plugin install <solver> # e.g. ltspice
|
|
115
|
+
# 2. Install the plugin for the solver you actually want:
|
|
116
|
+
sim plugin install sim-plugin-ltspice
|
|
119
117
|
|
|
120
118
|
# 3. Tell sim to look at this machine and pick the right SDK profile:
|
|
121
119
|
sim check <solver>
|
|
@@ -146,30 +144,24 @@ That's the full loop: **detect → bootstrap → launch → drive → observe
|
|
|
146
144
|
|
|
147
145
|
---
|
|
148
146
|
|
|
149
|
-
## 📦 Plugin
|
|
147
|
+
## 📦 Plugin sources
|
|
150
148
|
|
|
151
|
-
`sim plugin install <
|
|
149
|
+
`sim plugin install <source>` accepts explicit install sources only:
|
|
152
150
|
|
|
153
|
-
|
|
154
|
-
|
|
151
|
+
- Exact package specs, such as `sim-plugin-ltspice` or `sim-plugin-ltspice==0.2.3`
|
|
152
|
+
- Package specs plus private indexes, such as `sim-plugin-mechanical --extra-index-url https://example.com/simple/`
|
|
153
|
+
- Direct wheel/sdist URLs, such as `https://example.com/sim_plugin_ltspice-0.2.3-py3-none-any.whl`
|
|
154
|
+
- Git URLs, such as `git+https://github.com/<org>/sim-plugin-<name>`
|
|
155
|
+
- Local plugin directories, wheels, and sdists
|
|
155
156
|
|
|
156
|
-
|
|
157
|
+
Discovery is separate from installation:
|
|
157
158
|
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
{
|
|
162
|
-
"updated": "<ISO date>",
|
|
163
|
-
"plugins": {
|
|
164
|
-
"<name>": {
|
|
165
|
-
"version": "<X.Y.Z>",
|
|
166
|
-
"wheel": "https://cdn.svdailab.com/wheels/<file>.whl"
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
}
|
|
159
|
+
```bash
|
|
160
|
+
sim plugin catalog # official plugins (display + copy-paste install string)
|
|
161
|
+
sim plugin list # installed/registered plugins on this machine
|
|
170
162
|
```
|
|
171
163
|
|
|
172
|
-
|
|
164
|
+
Short solver aliases such as `ltspice` are catalogue names, not install sources. Run `sim plugin catalog` to find the recommended install string for each plugin, then pass it to `sim plugin install`.
|
|
173
165
|
|
|
174
166
|
---
|
|
175
167
|
|
|
@@ -179,20 +171,24 @@ To install a wheel directly without going through the resolver, hand `sim plugin
|
|
|
179
171
|
|
|
180
172
|
`sim` is most useful for **GUI-heavy solvers** — COMSOL, ANSYS Mechanical, ANSYS Fluent, MATLAB Simulink, Abaqus, Flotherm — where every agent iteration would otherwise mean clicking through dialog boxes.
|
|
181
173
|
|
|
182
|
-
Install
|
|
174
|
+
Install from a discovered package, then list what is installed locally:
|
|
183
175
|
|
|
184
176
|
```bash
|
|
185
|
-
sim plugin
|
|
186
|
-
sim plugin install
|
|
177
|
+
sim plugin catalog # discover what's available + install strings
|
|
178
|
+
sim plugin install sim-plugin-ltspice
|
|
179
|
+
sim plugin list # show installed plugins
|
|
187
180
|
```
|
|
188
181
|
|
|
189
182
|
Reference implementation to read for shape: [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice).
|
|
190
183
|
|
|
191
|
-
**Private plugins** (vendor-IP-sensitive backends
|
|
184
|
+
**Private plugins** (vendor-IP-sensitive backends) install through explicit URLs, private repos, or private Python indexes — same `sim plugin install` flow:
|
|
192
185
|
|
|
193
186
|
```bash
|
|
194
187
|
sim plugin install git+https://github.com/<org>/sim-plugin-<name>
|
|
195
188
|
# (you need read-access to the repo; without it, git clone returns 401)
|
|
189
|
+
|
|
190
|
+
sim plugin install sim-plugin-mechanical --extra-index-url https://example.com/simple/
|
|
191
|
+
# standard PEP 503/private-index path for commercial wrappers
|
|
196
192
|
```
|
|
197
193
|
|
|
198
194
|
Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
|
|
@@ -210,7 +206,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
|
|
|
210
206
|
### 🔌 Solver-agnostic
|
|
211
207
|
- **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
|
|
212
208
|
- **Persistent + one-shot** from the same CLI — no separate client per mode
|
|
213
|
-
- **Plugin
|
|
209
|
+
- **Plugin discovery + explicit installs** — `sim plugin catalog` discovers available plugins; `sim plugin install` accepts exact package specs, private indexes, direct URLs, git URLs, and local artifacts
|
|
214
210
|
- **Companion skills** in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) so an LLM picks up each new backend without prior context
|
|
215
211
|
|
|
216
212
|
### 🌐 Remote-friendly
|
|
@@ -224,7 +220,8 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
|
|
|
224
220
|
|
|
225
221
|
| Command | What it does | Analogy |
|
|
226
222
|
|---|---|---|
|
|
227
|
-
| `sim plugin
|
|
223
|
+
| `sim plugin catalog` | Discover available solver plugins | `npm search` |
|
|
224
|
+
| `sim plugin list / install / uninstall` | Manage installed plugins from explicit install sources | `npm install` |
|
|
228
225
|
| `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
|
|
229
226
|
| `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
|
|
230
227
|
| `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
|
|
@@ -300,7 +297,6 @@ That is the entire setup — same `sim-cli-core` package on both sides, same wir
|
|
|
300
297
|
|
|
301
298
|
## 🔗 Related projects
|
|
302
299
|
|
|
303
|
-
- **[`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)** — community-maintained plugin catalogue; second of two sources `sim plugin install <name>` resolves against (the first is the svd-maintained manifest at `cdn.svdailab.com/manifest.json`)
|
|
304
300
|
- **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
|
|
305
301
|
- **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
|
|
306
302
|
|
|
@@ -35,7 +35,8 @@ src/sim/
|
|
|
35
35
|
driver.py DriverProtocol + result dataclasses
|
|
36
36
|
compat.py Version-compat profiles + layered skill resolution
|
|
37
37
|
plugins.py Plugin discovery, listing, info
|
|
38
|
-
|
|
38
|
+
plugin_catalog.py Catalogue/discovery fetch + normalization
|
|
39
|
+
_plugin_install.py Explicit install / uninstall sources
|
|
39
40
|
drivers/
|
|
40
41
|
__init__.py Plugin registry — discovers external plugins
|
|
41
42
|
via the `sim.drivers` entry-point group at
|
|
@@ -135,30 +135,24 @@ sim --host <server-ip> disconnect
|
|
|
135
135
|
|
|
136
136
|
---
|
|
137
137
|
|
|
138
|
-
## 📦
|
|
138
|
+
## 📦 插件来源
|
|
139
139
|
|
|
140
|
-
`sim plugin install <
|
|
140
|
+
`sim plugin install <source>` 只接受显式安装来源:
|
|
141
141
|
|
|
142
|
-
|
|
143
|
-
|
|
142
|
+
- 精确 package spec,例如 `sim-plugin-ltspice` 或 `sim-plugin-ltspice==0.2.3`
|
|
143
|
+
- 精确包名加私有索引,例如 `sim-plugin-mechanical --extra-index-url https://example.com/simple/`
|
|
144
|
+
- 直接 wheel/sdist URL,例如 `https://example.com/sim_plugin_ltspice-0.2.3-py3-none-any.whl`
|
|
145
|
+
- git URL,例如 `git+https://github.com/<org>/sim-plugin-<name>`
|
|
146
|
+
- 本地插件目录、wheel 或 sdist
|
|
144
147
|
|
|
145
|
-
|
|
148
|
+
插件发现和安装分开:
|
|
146
149
|
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
{
|
|
151
|
-
"updated": "<ISO date>",
|
|
152
|
-
"plugins": {
|
|
153
|
-
"<name>": {
|
|
154
|
-
"version": "<X.Y.Z>",
|
|
155
|
-
"wheel": "https://cdn.svdailab.com/wheels/<file>.whl"
|
|
156
|
-
}
|
|
157
|
-
}
|
|
158
|
-
}
|
|
150
|
+
```bash
|
|
151
|
+
sim plugin catalog # 查看官方插件目录(含可直接复制的安装命令)
|
|
152
|
+
sim plugin list # 查看本机已安装/已注册插件
|
|
159
153
|
```
|
|
160
154
|
|
|
161
|
-
|
|
155
|
+
`ltspice` 这样的短别名是 catalogue 名称,不是安装来源。运行 `sim plugin catalog` 查看每个插件推荐的安装字符串,然后将其传给 `sim plugin install`。
|
|
162
156
|
|
|
163
157
|
---
|
|
164
158
|
|
|
@@ -173,7 +167,7 @@ svd manifest 的 schema(社区 catalogue 是另一种 shape,看它仓库里
|
|
|
173
167
|
### 🔌 求解器无关
|
|
174
168
|
- **一套协议** (`DriverProtocol`) —— 每个 driver 仅 ~200 行,注册到 `drivers/__init__.py` 即可
|
|
175
169
|
- **持久 + 一次性**两种模式共用同一个 CLI
|
|
176
|
-
-
|
|
170
|
+
- **插件发现 + 显式安装** —— `sim plugin catalog` 用来发现可用插件;`sim plugin install` 只执行精确包名、私有索引、URL、git 或本地 artifact
|
|
177
171
|
- **配套 skills** 在 [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) —— 让大模型立刻知道每个新后端的坑
|
|
178
172
|
|
|
179
173
|
### 🌐 远程友好
|
|
@@ -187,6 +181,8 @@ svd manifest 的 schema(社区 catalogue 是另一种 shape,看它仓库里
|
|
|
187
181
|
|
|
188
182
|
| 命令 | 功能 | 类比 |
|
|
189
183
|
|---|---|---|
|
|
184
|
+
| `sim plugin catalog` | 发现可用插件 | `npm search` |
|
|
185
|
+
| `sim plugin list / install / uninstall` | 管理本机已安装插件 | `npm install` |
|
|
190
186
|
| `sim check <solver>` | 检测安装版本并解析 profile | `docker info` |
|
|
191
187
|
| `sim env install <profile>` | 启动 profile env(venv + 固定 SDK) | `pyenv install` |
|
|
192
188
|
| `sim env list [--catalogue]` | 列出已启动的 env(或全部目录) | `pyenv versions` |
|
|
@@ -58,7 +58,7 @@ top-level keys (`stdout`, `stderr`); never inside `message`.
|
|
|
58
58
|
| `LINT_FAILED` | `sim lint` produced at least one error-level diagnostic. |
|
|
59
59
|
| `RUN_FAILED` | The solver returned non-zero or the driver detected an error in the output. |
|
|
60
60
|
| `SESSION_NOT_FOUND` | `--session <id>` does not match any active session on the server. |
|
|
61
|
-
| `PLUGIN_NOT_FOUND` | `sim plugin`
|
|
61
|
+
| `PLUGIN_NOT_FOUND` | `sim plugin install` received an invalid explicit source, or a plugin name is not installed. |
|
|
62
62
|
| `PLUGIN_INSTALL_FAILED` | `pip install` for a plugin returned non-zero. |
|
|
63
63
|
| `PROTOCOL_VIOLATION` | A driver returned a value that doesn't match `DriverProtocol`. |
|
|
64
64
|
| `NONINTERACTIVE_INPUT_REQUIRED` | `--no-interactive` is set and the command would otherwise prompt. |
|
|
@@ -8,20 +8,23 @@ covers every way to install one.
|
|
|
8
8
|
|
|
9
9
|
| Situation | Command |
|
|
10
10
|
|---|---|
|
|
11
|
-
|
|
|
11
|
+
| Discover available plugins | `sim plugin catalog` |
|
|
12
|
+
| PyPI package | `sim plugin install sim-plugin-coolprop` |
|
|
13
|
+
| Pinned PyPI package | `sim plugin install sim-plugin-coolprop==0.1.0` |
|
|
14
|
+
| Private package index | `sim plugin install sim-plugin-mechanical --extra-index-url https://example.com/simple/` |
|
|
15
|
+
| Direct URL | `sim plugin install https://example.com/sim_plugin_coolprop-0.1.0-py3-none-any.whl` |
|
|
12
16
|
| Online, plugin you cloned locally | `sim plugin install ./sim-plugin-coolprop` |
|
|
13
17
|
| Offline (you have a wheel file) | `sim plugin install ./sim_plugin_coolprop-0.1.0-py3-none-any.whl` |
|
|
14
|
-
| Air-gapped (you have a bundle dir) | `sim plugin install --offline --from-dir ./bundle/ --all` |
|
|
15
18
|
| Editable (you author plugins) | `sim plugin install -e ./sim-plugin-coolprop` |
|
|
16
19
|
|
|
17
20
|
## How `sim plugin install <source>` resolves
|
|
18
21
|
|
|
19
22
|
`<source>` accepts any of:
|
|
20
23
|
|
|
21
|
-
1.
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
24
|
+
1. `sim-plugin-<name>` or `sim-plugin-<name>==<version>` — exact package
|
|
25
|
+
spec passed directly to pip/uv.
|
|
26
|
+
2. `sim-plugin-<name> --extra-index-url https://.../simple/` — exact
|
|
27
|
+
package spec plus an additional private Python package index.
|
|
25
28
|
3. `https://...whl` or `https://...tar.gz` — direct URL to a wheel or
|
|
26
29
|
sdist. Plain pip + HTTPS, works behind corporate proxies.
|
|
27
30
|
4. `./path/to/dir` — local plugin source directory. `pip install <dir>`.
|
|
@@ -29,28 +32,41 @@ covers every way to install one.
|
|
|
29
32
|
`pip install <path>`.
|
|
30
33
|
6. `git+https://...` or `git+ssh://...` — git URL (when git is available).
|
|
31
34
|
|
|
35
|
+
Bare short names such as `coolprop` or `ltspice` are catalogue names, not
|
|
36
|
+
install sources. Run `sim plugin catalog` to see the official plugin list
|
|
37
|
+
with the recommended explicit install command for each, then pass that
|
|
38
|
+
command's argument to `sim plugin install`.
|
|
39
|
+
|
|
32
40
|
After the package installs, `sim plugin install` runs `sync-skills`
|
|
33
41
|
automatically so the plugin's bundled `_skills/<solver>/` becomes
|
|
34
42
|
discoverable to Claude Code (or any consumer of `.claude/skills/`).
|
|
35
43
|
|
|
36
|
-
##
|
|
44
|
+
## Discovery catalogue
|
|
45
|
+
|
|
46
|
+
Agents can discover available plugins without installing anything:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
sim plugin catalog
|
|
50
|
+
sim --json plugin catalog
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
The catalogue is for discovery only. Each entry includes a copy-paste
|
|
54
|
+
`install` string that callers pass to `sim plugin install`. The catalogue
|
|
55
|
+
is advisory metadata; `sim plugin install <short-name>` does not silently
|
|
56
|
+
resolve a catalogue name into a URL or package.
|
|
57
|
+
|
|
58
|
+
## Online
|
|
37
59
|
|
|
38
60
|
```sh
|
|
39
|
-
sim plugin install coolprop
|
|
61
|
+
sim plugin install sim-plugin-coolprop
|
|
40
62
|
```
|
|
41
63
|
|
|
42
64
|
This is enough on a typical developer laptop. Requires:
|
|
43
65
|
|
|
44
66
|
- `sim-cli-core` already installed.
|
|
45
|
-
- HTTPS access to
|
|
67
|
+
- HTTPS access to the package index, direct URL, or git host you provide.
|
|
46
68
|
- `pip` (it ships with Python).
|
|
47
69
|
|
|
48
|
-
Does NOT require:
|
|
49
|
-
|
|
50
|
-
- `git` CLI.
|
|
51
|
-
- `gh` CLI.
|
|
52
|
-
- A GitHub account or auth (for OSS plugins).
|
|
53
|
-
|
|
54
70
|
## Offline (single artifact)
|
|
55
71
|
|
|
56
72
|
If you have a wheel or sdist file (downloaded from a release page, sent by
|
|
@@ -64,40 +80,6 @@ The skill ships *inside* the wheel under `_skills/<solver>/`, so this
|
|
|
64
80
|
single command brings up both the driver and the skill. No network access
|
|
65
81
|
is required.
|
|
66
82
|
|
|
67
|
-
## Air-gapped (bundle)
|
|
68
|
-
|
|
69
|
-
For lab/regulated environments without external network, the bundle flow:
|
|
70
|
-
|
|
71
|
-
**On a connected machine:**
|
|
72
|
-
|
|
73
|
-
```sh
|
|
74
|
-
sim plugin bundle coolprop simpy gmsh --output ./plugins-bundle/
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
This produces:
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
-
plugins-bundle/
|
|
81
|
-
index.json (filtered to bundled plugins,
|
|
82
|
-
with file:// URLs)
|
|
83
|
-
sim_plugin_coolprop-0.1.0-py3-none-any.whl
|
|
84
|
-
sim_plugin_simpy-0.1.0-py3-none-any.whl
|
|
85
|
-
sim_plugin_gmsh-0.1.0-py3-none-any.whl
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
**Ship the directory** (USB, secure file transfer, etc.).
|
|
89
|
-
|
|
90
|
-
**On the air-gapped machine:**
|
|
91
|
-
|
|
92
|
-
```sh
|
|
93
|
-
sim plugin install --offline --from-dir ./plugins-bundle/ coolprop simpy gmsh
|
|
94
|
-
# or, install everything in the bundle:
|
|
95
|
-
sim plugin install --offline --from-dir ./plugins-bundle/ --all
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
`--offline` forces the resolver to use the bundle's local `index.json` and
|
|
99
|
-
refuse network calls.
|
|
100
|
-
|
|
101
83
|
## Editable (plugin authors)
|
|
102
84
|
|
|
103
85
|
If you're authoring or debugging a plugin:
|
|
@@ -113,6 +95,13 @@ development.
|
|
|
113
95
|
## Commercial plugins
|
|
114
96
|
|
|
115
97
|
Commercial plugin availability depends on third-party license conditions.
|
|
98
|
+
Private wrappers should be distributed through explicit private repos, direct
|
|
99
|
+
wheel URLs, or a standard private Python package index:
|
|
100
|
+
|
|
101
|
+
```sh
|
|
102
|
+
sim plugin install sim-plugin-mechanical --extra-index-url https://example.com/simple/
|
|
103
|
+
```
|
|
104
|
+
|
|
116
105
|
Contact <contact@svd-ai-lab.com> to discuss commercial plugin access.
|
|
117
106
|
|
|
118
107
|
## Surviving `uv sync`
|
|
@@ -125,7 +114,7 @@ anything else. To keep installed plugins across `uv sync` invocations,
|
|
|
125
114
|
|
|
126
115
|
```toml
|
|
127
116
|
[tool.sim.plugins]
|
|
128
|
-
coolprop = {
|
|
117
|
+
coolprop = { package = "sim-plugin-coolprop", version = ">=0.1.0" }
|
|
129
118
|
gmsh = { git = "https://github.com/svd-ai-lab/sim-plugin-gmsh", rev = "v0.1.0" }
|
|
130
119
|
local_plugin = { wheel = "./vendor/sim_plugin_local-1.2.0-py3-none-any.whl" }
|
|
131
120
|
```
|
|
@@ -146,7 +135,7 @@ After install, check the plugin loaded cleanly:
|
|
|
146
135
|
```sh
|
|
147
136
|
sim plugin list # one row per installed plugin
|
|
148
137
|
sim plugin doctor coolprop # detailed validation
|
|
149
|
-
sim plugin doctor --all
|
|
138
|
+
sim --json plugin doctor --all # machine-readable
|
|
150
139
|
```
|
|
151
140
|
|
|
152
141
|
`doctor` checks that the plugin's entry-points resolve, the driver
|