sim-cli-core 0.3.0__tar.gz → 0.3.2__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.
Files changed (130) hide show
  1. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/CLAUDE.md +1 -1
  2. sim_cli_core-0.3.2/NOTICE +35 -0
  3. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/PKG-INFO +71 -24
  4. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/README.md +70 -23
  5. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/assets/architecture.svg +6 -6
  6. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/assets/banner.svg +5 -5
  7. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/DEVELOPMENT.md +23 -17
  8. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/README.zh.md +52 -41
  9. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/agent-readability.md +3 -3
  10. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/architecture/version-compat.md +1 -1
  11. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/plugin-install.md +39 -74
  12. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/pyproject.toml +1 -1
  13. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/_plugin_install.py +71 -170
  14. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/cli.py +125 -15
  15. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/compat.py +23 -1
  16. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/config.py +8 -11
  17. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/describe.py +11 -3
  18. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/history.py +6 -0
  19. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/inspect.py +48 -12
  20. sim_cli_core-0.3.2/src/sim/plugin_catalog.py +232 -0
  21. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/server.py +37 -3
  22. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/session.py +4 -1
  23. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_cli.py +28 -5
  24. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_compat.py +18 -0
  25. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_init_setup.py +16 -6
  26. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_multi_session.py +41 -1
  27. sim_cli_core-0.3.2/tests/base/test_plugin_catalog.py +137 -0
  28. sim_cli_core-0.3.2/tests/base/test_plugin_install.py +248 -0
  29. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/conftest.py +7 -1
  30. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/test_gui_probes.py +113 -0
  31. sim_cli_core-0.3.0/NOTICE +0 -72
  32. sim_cli_core-0.3.0/tests/base/test_plugin_install.py +0 -307
  33. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/.github/workflows/publish.yml +0 -0
  34. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/.gitignore +0 -0
  35. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/CONTRIBUTING.md +0 -0
  36. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/LICENSE +0 -0
  37. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/assets/logo.svg +0 -0
  38. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/README.de.md +0 -0
  39. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/README.ja.md +0 -0
  40. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/architecture/multi-session-and-config.md +0 -0
  41. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/docs/architecture/skills-layering-plan.md +0 -0
  42. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/__init__.py +0 -0
  43. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/__main__.py +0 -0
  44. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/_timeout.py +0 -0
  45. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/driver.py +0 -0
  46. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/drivers/__init__.py +0 -0
  47. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
  48. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/gui/__init__.py +0 -0
  49. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/gui/_pywinauto_tools.py +0 -0
  50. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/gui/_win32_dialog.py +0 -0
  51. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/plugins.py +0 -0
  52. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/runner.py +0 -0
  53. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/testing/__init__.py +0 -0
  54. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/src/sim/testing/protocol_conformance.py +0 -0
  55. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/__init__.py +0 -0
  56. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/__init__.py +0 -0
  57. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_config.py +0 -0
  58. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_connect.py +0 -0
  59. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_describe.py +0 -0
  60. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_driver_discovery.py +0 -0
  61. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_history.py +0 -0
  62. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_lint.py +0 -0
  63. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_lint_public_corpus.py +0 -0
  64. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_logs.py +0 -0
  65. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_plugins.py +0 -0
  66. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_protocol_conformance.py +0 -0
  67. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/base/test_run.py +0 -0
  68. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/drivers/__init__.py +0 -0
  69. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/calculix_e2e_cantilever_run.py +0 -0
  70. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/coolprop/water_props.py +0 -0
  71. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/elmer_e2e_heat_square.py +0 -0
  72. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/gmsh_e2e_sphere_mesh.py +0 -0
  73. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/lammps_e2e_lj_nvt.py +0 -0
  74. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/meshio_e2e_gmsh_to_vtk.py +0 -0
  75. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/pymfem_e2e_poisson.py +0 -0
  76. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/pyvista_e2e_sphere_stats.py +0 -0
  77. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/scikit_fem_e2e_poisson.py +0 -0
  78. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/scikitrf/short_load.py +0 -0
  79. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/execution/su2_e2e_inviscid_bump.py +0 -0
  80. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/comsol/comsol_good.py +0 -0
  81. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/comsol/comsol_no_client.py +0 -0
  82. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/comsol/comsol_no_import.py +0 -0
  83. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/hypermesh_good.py +0 -0
  84. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/hypermesh_gui.py +0 -0
  85. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/hypermesh_no_import.py +0 -0
  86. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/hypermesh_no_usage.py +0 -0
  87. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/hypermesh_syntax_error.py +0 -0
  88. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/bad_import_order.py +0 -0
  89. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/bad_no_close.py +0 -0
  90. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/bad_no_simapp.py +0 -0
  91. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/hello_world.py +0 -0
  92. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/import_franka.py +0 -0
  93. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/not_isaac.py +0 -0
  94. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/official_hello_world.py +0 -0
  95. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/replicator_cubes.py +0 -0
  96. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/syntax_error.py +0 -0
  97. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/isaac/warehouse_sdg.py +0 -0
  98. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/matlab/empty_model.mdl +0 -0
  99. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/matlab/empty_model.slx +0 -0
  100. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/matlab/matlab_ok.m +0 -0
  101. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/mfem_good.py +0 -0
  102. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/mfem_no_import.py +0 -0
  103. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/mfem_no_mesh.py +0 -0
  104. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/mfem_syntax_error.py +0 -0
  105. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/mock_fail.py +0 -0
  106. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/mock_solver.py +0 -0
  107. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/newton/basic_pendulum.json +0 -0
  108. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/newton/cable_twist.py +0 -0
  109. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/newton/robot_g1.json +0 -0
  110. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/not_simulation.py +0 -0
  111. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/pybamm/pybamm_bad_import.py +0 -0
  112. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/pybamm/pybamm_crate_sweep.py +0 -0
  113. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/pybamm/pybamm_no_solve.py +0 -0
  114. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/pybamm/pybamm_spm_good.py +0 -0
  115. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/skfem_good.py +0 -0
  116. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/skfem_no_import.py +0 -0
  117. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/skfem_no_solve.py +0 -0
  118. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/fixtures/skfem_syntax_error.py +0 -0
  119. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/gui/__init__.py +0 -0
  120. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/gui/test_connect_tools_field.py +0 -0
  121. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/gui/test_gui_facade.py +0 -0
  122. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/__init__.py +0 -0
  123. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/_extract_comsol_Tmax.py +0 -0
  124. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/test_channel_3_4_5_9.py +0 -0
  125. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/test_inspect_types.py +0 -0
  126. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/test_probes.py +0 -0
  127. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tests/inspect/test_snippet_timeout.py +0 -0
  128. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tools/extract_driver.py +0 -0
  129. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/tools/lint-public-corpus.py +0 -0
  130. {sim_cli_core-0.3.0 → sim_cli_core-0.3.2}/uv.lock +0 -0
@@ -87,7 +87,7 @@ The server supports multiple concurrent sessions keyed by session_id. Each `Sess
87
87
  Drivers are resolved lazily through two channels:
88
88
 
89
89
  - **`_BUILTIN_REGISTRY`** — an ordered list of `(name, "module:Class")` tuples for the open-source drivers that ship with `sim-cli-core` itself (PyBaMM, OpenFOAM, CalculiX, gmsh, SU2, LAMMPS, Elmer, scikit-fem, MFEM, OpenSeesPy, SfePy, OpenMDAO, FiPy, pymoo, Pyomo, SimPy, Trimesh, Devito, CoolProp, scikit-rf, pandapower, ParaView, meshio, PyVista, Newton, Isaac Sim, LTspice). The canonical list lives in `src/sim/drivers/__init__.py`.
90
- - **`sim.drivers` entry-point group** — external/closed-source drivers register themselves via standard Python entry points and are discovered at import time, validated, and appended after the built-ins. Built-ins win on name collisions. This is the path used by every commercial-solver plugin (each lives in its own out-of-tree package with its own `compatibility.yaml`).
90
+ - **`sim.drivers` entry-point group** — external drivers register themselves via standard Python entry points and are discovered at import time, validated, and appended after the built-ins. Built-ins win on name collisions. Each plugin lives in its own out-of-tree package with its own `compatibility.yaml`.
91
91
 
92
92
  A driver may set `supports_session = True` to implement the persistent-session lifecycle (`launch`/`run`/`query`/`disconnect`); the rest are one-shot only. `get_driver(name)` looks up by `.name` attribute and lazily imports the implementation module on first use, so a broken plugin does not crash the CLI.
93
93
 
@@ -0,0 +1,35 @@
1
+ sim-cli
2
+ Copyright 2026 Weiqi Ji
3
+
4
+ This product is licensed under the Apache License, Version 2.0 (the "License");
5
+ see the accompanying LICENSE file for the full text.
6
+
7
+ ================================================================================
8
+ Plugin and runtime dependency notice
9
+ ================================================================================
10
+
11
+ sim-cli is a solver-agnostic runtime. Solver and tool integrations are provided
12
+ by separately installed plugins. Plugins may depend on third-party software,
13
+ services, SDKs, or local executables that are not bundled with this repository.
14
+ Users are responsible for complying with the license, copyright, and end-user
15
+ terms that apply to any third-party software they install or use with a plugin.
16
+
17
+ Commercial plugin availability depends on third-party license conditions.
18
+ Contact <contact@svd-ai-lab.com> to discuss commercial plugin access.
19
+
20
+ ================================================================================
21
+ Direct runtime dependencies (see pyproject.toml)
22
+ ================================================================================
23
+
24
+ click, httpx, fastapi, uvicorn, pyyaml, Pillow, lxml
25
+ - each distributed under its own open-source license (BSD / MIT /
26
+ Apache-2.0 family); consult the respective package for terms.
27
+
28
+ ================================================================================
29
+ Trademarks
30
+ ================================================================================
31
+
32
+ Product, solver, tool, and company names may be trademarks or registered
33
+ trademarks of their respective owners. sim-cli is an independent open-source
34
+ project and is not affiliated with, endorsed by, or sponsored by any third-party
35
+ vendor unless explicitly stated.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sim-cli-core
3
- Version: 0.3.0
3
+ Version: 0.3.2
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
@@ -66,7 +66,7 @@ Description-Content-Type: text/markdown
66
66
 
67
67
  **English** · [Deutsch](docs/README.de.md) · [日本語](docs/README.ja.md) · [中文](docs/README.zh.md)
68
68
 
69
- [Why sim](#-why-sim) · [Quick Start](#-quick-start) · [Solvers](#-solver-registry) · [Commands](#-commands) · [Demo](#-demo) · [Skills](https://github.com/svd-ai-lab/sim-skills)
69
+ [Why sim](#-why-sim) · [Quick Start](#-quick-start) · [Solvers](#-solver-registry) · [Commands](#-commands) · [Skills](https://github.com/svd-ai-lab/sim-skills)
70
70
 
71
71
  </div>
72
72
 
@@ -114,14 +114,17 @@ For the full driver protocol, server endpoints, and execution pipeline see [CLAU
114
114
 
115
115
  > **Names at a glance:** repo `svd-ai-lab/sim-cli` · PyPI distribution `sim-cli-core` · console command `sim` · import `import sim`. Yes, three different strings — the repo name predates the PyPI publish; the rest follow Python packaging convention.
116
116
 
117
+ Prereq: [`uv`](https://docs.astral.sh/uv/) — install with `curl -LsSf https://astral.sh/uv/install.sh | sh` (macOS / Linux) or `irm https://astral.sh/uv/install.ps1 | iex` (Windows PowerShell).
118
+
119
+ **macOS / Linux:**
120
+
117
121
  ```bash
118
122
  # 1. On the host that has the solver installed, install sim core only
119
123
  # — no driver choice yet:
120
124
  uv pip install sim-cli-core
121
125
 
122
- # 2. Install the plugin for the solver you actually want (browse the
123
- # index with `sim plugin list`):
124
- sim plugin install <solver> # e.g. ltspice, coolprop, pybamm
126
+ # 2. Install the plugin for the solver you actually want:
127
+ sim plugin install sim-plugin-ltspice
125
128
 
126
129
  # 3. Tell sim to look at this machine and pick the right SDK profile:
127
130
  sim check <solver>
@@ -142,6 +145,33 @@ sim --host <server-ip> screenshot -o shot.png
142
145
  sim --host <server-ip> disconnect
143
146
  ```
144
147
 
148
+ **Windows (PowerShell):**
149
+
150
+ ```powershell
151
+ # 1. On the host that has the solver installed, install sim core only
152
+ # — no driver choice yet:
153
+ uv pip install sim-cli-core
154
+
155
+ # 2. Install the plugin for the solver you actually want:
156
+ sim plugin install sim-plugin-ltspice
157
+
158
+ # 3. Tell sim to look at this machine and pick the right SDK profile:
159
+ sim check <solver>
160
+
161
+ # 4. Bootstrap that profile env (or pass --auto-install to step 5):
162
+ sim env install <profile>
163
+
164
+ # 5. Start the server (only needed for remote / cross-machine workflows):
165
+ sim serve --host 0.0.0.0 # FastAPI on :7600
166
+
167
+ # 6. From the agent / your laptop / anywhere on the network:
168
+ sim --host <server-ip> connect --solver <solver> --mode solver --ui-mode gui
169
+ sim --host <server-ip> inspect session.versions # ← always do this first
170
+ sim --host <server-ip> exec "<solver-specific snippet>"
171
+ sim --host <server-ip> screenshot -o shot.png
172
+ sim --host <server-ip> disconnect
173
+ ```
174
+
145
175
  That's the full loop: **detect → bootstrap → launch → drive → observe → tear down** — with the engineer optionally watching the solver GUI in real time.
146
176
 
147
177
  > **Why the bootstrap step?** Each `(solver, SDK, driver, skill)` combo is
@@ -154,37 +184,54 @@ That's the full loop: **detect → bootstrap → launch → drive → observe
154
184
 
155
185
  ---
156
186
 
157
- ## 🧪 Solver registry
187
+ ## 📦 Plugin sources
188
+
189
+ `sim plugin install <source>` accepts explicit install sources only:
158
190
 
159
- `sim-cli` core is **fully solver-agnostic** — it ships with **zero built-in drivers**. Every solver, including OpenFOAM, is reached through an **out-of-tree plugin package** registered via the `sim.drivers` entry-point group. Adding a new backend is a ~200-LOC `DriverProtocol` implementation in its own `sim-plugin-<name>` repo.
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
160
196
 
161
- Plugin coverage spans CFD, multiphysics, electronics thermal, implicit and explicit structural FEA, pre/post-processing, mesh generation, embodied-AI / GPU physics, molecular dynamics, optimization / MDAO, battery modeling, thermo properties, power-systems and RF simulation, and discrete-event modeling. Browse the curated index:
197
+ Discovery is separate from installation:
162
198
 
163
199
  ```bash
164
- sim plugin list # what the curated index advertises
165
- sim plugin install <name> # e.g. sim plugin install ltspice
200
+ sim plugin catalog # official plugins (display + copy-paste install string)
201
+ sim plugin list # installed/registered plugins on this machine
166
202
  ```
167
203
 
168
- The index is served from [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index); reference plugins to read for shape: [`sim-plugin-coolprop`](https://github.com/svd-ai-lab/sim-plugin-coolprop) (one-shot, no SDK gate), [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice) (one-shot with vendor binary), [`sim-plugin-pybamm`](https://github.com/svd-ai-lab/sim-plugin-pybamm) (heavy SDK).
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`.
205
+
206
+ ---
207
+
208
+ ## 🧪 Solver registry
209
+
210
+ `sim-cli` core is **fully solver-agnostic** — it ships with **zero built-in drivers**. Every solver is reached through a **plugin package** registered via the `sim.drivers` entry-point group. Adding a new backend is a ~200-LOC `DriverProtocol` implementation in its own `sim-plugin-<name>` repo.
169
211
 
170
- **Private plugins** (vendor-IP-sensitive backends not in the public index) install directly by URL — same `sim plugin install` flow:
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.
213
+
214
+ Install from a discovered package, then list what is installed locally:
171
215
 
172
216
  ```bash
173
- sim plugin install git+https://github.com/<org>/sim-plugin-<name>
174
- # (you need read-access to the repo; without it, git clone returns 401)
217
+ sim plugin catalog # discover what's available + install strings
218
+ sim plugin install sim-plugin-ltspice
219
+ sim plugin list # show installed plugins
175
220
  ```
176
221
 
177
- Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
222
+ Reference implementation to read for shape: [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice).
178
223
 
179
- ---
224
+ **Private plugins** (vendor-IP-sensitive backends) install through explicit URLs, private repos, or private Python indexes — same `sim plugin install` flow:
180
225
 
181
- ## 🎬 Demo
226
+ ```bash
227
+ sim plugin install git+https://github.com/<org>/sim-plugin-<name>
228
+ # (you need read-access to the repo; without it, git clone returns 401)
182
229
 
183
- > 📺 **Early preview:** [first walkthrough on YouTube](https://www.youtube.com/watch?v=3Fg6Oph44Ik) — rough cut, a polished recording is still wanted (see below).
230
+ sim plugin install sim-plugin-mechanical --extra-index-url https://example.com/simple/
231
+ # standard PEP 503/private-index path for commercial wrappers
232
+ ```
184
233
 
185
- > **Recording in progress.** A short terminal capture of `sim connect → exec → inspect → screenshot` against a live solver session will land here.
186
- >
187
- > Want to contribute the recording? Use [`vhs`](https://github.com/charmbracelet/vhs) or [`asciinema`](https://asciinema.org/) and open a PR against `assets/demo.gif`.
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.
188
235
 
189
236
  ---
190
237
 
@@ -199,7 +246,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
199
246
  ### 🔌 Solver-agnostic
200
247
  - **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
201
248
  - **Persistent + one-shot** from the same CLI — no separate client per mode
202
- - **Open plugin index** — discoverable via `sim plugin list`; curated registry at [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)
249
+ - **Plugin discovery + explicit installs** — `sim plugin catalog/search` discovers available plugins; `sim plugin install` accepts exact package specs, private indexes, direct URLs, git URLs, and local artifacts
203
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
204
251
 
205
252
  ### 🌐 Remote-friendly
@@ -213,7 +260,8 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
213
260
 
214
261
  | Command | What it does | Analogy |
215
262
  |---|---|---|
216
- | `sim plugin list / install / uninstall` | Manage out-of-tree solver plugins from the curated index | `npm install` |
263
+ | `sim plugin catalog / search` | Discover available solver plugins | `npm search` |
264
+ | `sim plugin list / install / uninstall` | Manage installed plugins from explicit install sources | `npm install` |
217
265
  | `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
218
266
  | `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
219
267
  | `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
@@ -289,7 +337,6 @@ That is the entire setup — same `sim-cli-core` package on both sides, same wir
289
337
 
290
338
  ## 🔗 Related projects
291
339
 
292
- - **[`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)** — curated registry of out-of-tree solver plugins; what `sim plugin list / install` reads
293
340
  - **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
294
341
  - **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
295
342
 
@@ -26,7 +26,7 @@
26
26
 
27
27
  **English** · [Deutsch](docs/README.de.md) · [日本語](docs/README.ja.md) · [中文](docs/README.zh.md)
28
28
 
29
- [Why sim](#-why-sim) · [Quick Start](#-quick-start) · [Solvers](#-solver-registry) · [Commands](#-commands) · [Demo](#-demo) · [Skills](https://github.com/svd-ai-lab/sim-skills)
29
+ [Why sim](#-why-sim) · [Quick Start](#-quick-start) · [Solvers](#-solver-registry) · [Commands](#-commands) · [Skills](https://github.com/svd-ai-lab/sim-skills)
30
30
 
31
31
  </div>
32
32
 
@@ -74,14 +74,17 @@ For the full driver protocol, server endpoints, and execution pipeline see [CLAU
74
74
 
75
75
  > **Names at a glance:** repo `svd-ai-lab/sim-cli` · PyPI distribution `sim-cli-core` · console command `sim` · import `import sim`. Yes, three different strings — the repo name predates the PyPI publish; the rest follow Python packaging convention.
76
76
 
77
+ Prereq: [`uv`](https://docs.astral.sh/uv/) — install with `curl -LsSf https://astral.sh/uv/install.sh | sh` (macOS / Linux) or `irm https://astral.sh/uv/install.ps1 | iex` (Windows PowerShell).
78
+
79
+ **macOS / Linux:**
80
+
77
81
  ```bash
78
82
  # 1. On the host that has the solver installed, install sim core only
79
83
  # — no driver choice yet:
80
84
  uv pip install sim-cli-core
81
85
 
82
- # 2. Install the plugin for the solver you actually want (browse the
83
- # index with `sim plugin list`):
84
- sim plugin install <solver> # e.g. ltspice, coolprop, pybamm
86
+ # 2. Install the plugin for the solver you actually want:
87
+ sim plugin install sim-plugin-ltspice
85
88
 
86
89
  # 3. Tell sim to look at this machine and pick the right SDK profile:
87
90
  sim check <solver>
@@ -102,6 +105,33 @@ sim --host <server-ip> screenshot -o shot.png
102
105
  sim --host <server-ip> disconnect
103
106
  ```
104
107
 
108
+ **Windows (PowerShell):**
109
+
110
+ ```powershell
111
+ # 1. On the host that has the solver installed, install sim core only
112
+ # — no driver choice yet:
113
+ uv pip install sim-cli-core
114
+
115
+ # 2. Install the plugin for the solver you actually want:
116
+ sim plugin install sim-plugin-ltspice
117
+
118
+ # 3. Tell sim to look at this machine and pick the right SDK profile:
119
+ sim check <solver>
120
+
121
+ # 4. Bootstrap that profile env (or pass --auto-install to step 5):
122
+ sim env install <profile>
123
+
124
+ # 5. Start the server (only needed for remote / cross-machine workflows):
125
+ sim serve --host 0.0.0.0 # FastAPI on :7600
126
+
127
+ # 6. From the agent / your laptop / anywhere on the network:
128
+ sim --host <server-ip> connect --solver <solver> --mode solver --ui-mode gui
129
+ sim --host <server-ip> inspect session.versions # ← always do this first
130
+ sim --host <server-ip> exec "<solver-specific snippet>"
131
+ sim --host <server-ip> screenshot -o shot.png
132
+ sim --host <server-ip> disconnect
133
+ ```
134
+
105
135
  That's the full loop: **detect → bootstrap → launch → drive → observe → tear down** — with the engineer optionally watching the solver GUI in real time.
106
136
 
107
137
  > **Why the bootstrap step?** Each `(solver, SDK, driver, skill)` combo is
@@ -114,37 +144,54 @@ That's the full loop: **detect → bootstrap → launch → drive → observe
114
144
 
115
145
  ---
116
146
 
117
- ## 🧪 Solver registry
147
+ ## 📦 Plugin sources
148
+
149
+ `sim plugin install <source>` accepts explicit install sources only:
118
150
 
119
- `sim-cli` core is **fully solver-agnostic** — it ships with **zero built-in drivers**. Every solver, including OpenFOAM, is reached through an **out-of-tree plugin package** registered via the `sim.drivers` entry-point group. Adding a new backend is a ~200-LOC `DriverProtocol` implementation in its own `sim-plugin-<name>` repo.
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
120
156
 
121
- Plugin coverage spans CFD, multiphysics, electronics thermal, implicit and explicit structural FEA, pre/post-processing, mesh generation, embodied-AI / GPU physics, molecular dynamics, optimization / MDAO, battery modeling, thermo properties, power-systems and RF simulation, and discrete-event modeling. Browse the curated index:
157
+ Discovery is separate from installation:
122
158
 
123
159
  ```bash
124
- sim plugin list # what the curated index advertises
125
- sim plugin install <name> # e.g. sim plugin install ltspice
160
+ sim plugin catalog # official plugins (display + copy-paste install string)
161
+ sim plugin list # installed/registered plugins on this machine
126
162
  ```
127
163
 
128
- The index is served from [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index); reference plugins to read for shape: [`sim-plugin-coolprop`](https://github.com/svd-ai-lab/sim-plugin-coolprop) (one-shot, no SDK gate), [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice) (one-shot with vendor binary), [`sim-plugin-pybamm`](https://github.com/svd-ai-lab/sim-plugin-pybamm) (heavy SDK).
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`.
165
+
166
+ ---
167
+
168
+ ## 🧪 Solver registry
169
+
170
+ `sim-cli` core is **fully solver-agnostic** — it ships with **zero built-in drivers**. Every solver is reached through a **plugin package** registered via the `sim.drivers` entry-point group. Adding a new backend is a ~200-LOC `DriverProtocol` implementation in its own `sim-plugin-<name>` repo.
129
171
 
130
- **Private plugins** (vendor-IP-sensitive backends not in the public index) install directly by URL — same `sim plugin install` flow:
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.
173
+
174
+ Install from a discovered package, then list what is installed locally:
131
175
 
132
176
  ```bash
133
- sim plugin install git+https://github.com/<org>/sim-plugin-<name>
134
- # (you need read-access to the repo; without it, git clone returns 401)
177
+ sim plugin catalog # discover what's available + install strings
178
+ sim plugin install sim-plugin-ltspice
179
+ sim plugin list # show installed plugins
135
180
  ```
136
181
 
137
- Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
182
+ Reference implementation to read for shape: [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice).
138
183
 
139
- ---
184
+ **Private plugins** (vendor-IP-sensitive backends) install through explicit URLs, private repos, or private Python indexes — same `sim plugin install` flow:
140
185
 
141
- ## 🎬 Demo
186
+ ```bash
187
+ sim plugin install git+https://github.com/<org>/sim-plugin-<name>
188
+ # (you need read-access to the repo; without it, git clone returns 401)
142
189
 
143
- > 📺 **Early preview:** [first walkthrough on YouTube](https://www.youtube.com/watch?v=3Fg6Oph44Ik) — rough cut, a polished recording is still wanted (see below).
190
+ sim plugin install sim-plugin-mechanical --extra-index-url https://example.com/simple/
191
+ # standard PEP 503/private-index path for commercial wrappers
192
+ ```
144
193
 
145
- > **Recording in progress.** A short terminal capture of `sim connect → exec → inspect → screenshot` against a live solver session will land here.
146
- >
147
- > Want to contribute the recording? Use [`vhs`](https://github.com/charmbracelet/vhs) or [`asciinema`](https://asciinema.org/) and open a PR against `assets/demo.gif`.
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.
148
195
 
149
196
  ---
150
197
 
@@ -159,7 +206,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
159
206
  ### 🔌 Solver-agnostic
160
207
  - **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
161
208
  - **Persistent + one-shot** from the same CLI — no separate client per mode
162
- - **Open plugin index** — discoverable via `sim plugin list`; curated registry at [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)
209
+ - **Plugin discovery + explicit installs** — `sim plugin catalog/search` discovers available plugins; `sim plugin install` accepts exact package specs, private indexes, direct URLs, git URLs, and local artifacts
163
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
164
211
 
165
212
  ### 🌐 Remote-friendly
@@ -173,7 +220,8 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
173
220
 
174
221
  | Command | What it does | Analogy |
175
222
  |---|---|---|
176
- | `sim plugin list / install / uninstall` | Manage out-of-tree solver plugins from the curated index | `npm install` |
223
+ | `sim plugin catalog / search` | Discover available solver plugins | `npm search` |
224
+ | `sim plugin list / install / uninstall` | Manage installed plugins from explicit install sources | `npm install` |
177
225
  | `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
178
226
  | `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
179
227
  | `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
@@ -249,7 +297,6 @@ That is the entire setup — same `sim-cli-core` package on both sides, same wir
249
297
 
250
298
  ## 🔗 Related projects
251
299
 
252
- - **[`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)** — curated registry of out-of-tree solver plugins; what `sim plugin list / install` reads
253
300
  - **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
254
301
  - **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
255
302
 
@@ -60,10 +60,10 @@
60
60
  <rect x="730" y="110" width="210" height="270" rx="12" fill="#0f172a" stroke="#334155"/>
61
61
  <text x="835" y="135" text-anchor="middle" fill="#cbd5e1" font-size="13" font-weight="600">DriverProtocol</text>
62
62
  <g font-size="12" fill="#e2e8f0">
63
- <text x="745" y="162">• fluent (PyFluent · sessions)</text>
64
- <text x="745" y="182">• comsol (JPype)</text>
65
- <text x="745" y="202">• openfoam (Linux subprocess)</text>
66
- <text x="745" y="222">• matlab (matlabengine)</text>
63
+ <text x="745" y="162">• plugin_a (persistent session)</text>
64
+ <text x="745" y="182">• plugin_b (batch process)</text>
65
+ <text x="745" y="202">• plugin_c (remote host)</text>
66
+ <text x="745" y="222">• plugin_d (GUI-capable)</text>
67
67
  <text x="745" y="242">• … more in the registry</text>
68
68
  <text x="745" y="270" fill="#cbd5e1">• + your driver here</text>
69
69
  <text x="745" y="288" font-size="11" fill="#94a3b8"> (~200 LOC, register in</text>
@@ -78,8 +78,8 @@
78
78
  <!-- live solver -->
79
79
  <rect x="490" y="240" width="220" height="140" rx="12" fill="#0f172a" stroke="#334155"/>
80
80
  <text x="600" y="265" text-anchor="middle" fill="#cbd5e1" font-size="13" font-weight="600">Live solver process</text>
81
- <text x="600" y="290" text-anchor="middle" fill="#86efac" font-size="13">Fluent GUI · COMSOL · MATLAB</text>
82
- <text x="600" y="310" text-anchor="middle" fill="#86efac" font-size="13">ANSA · Flotherm · OpenFOAM</text>
81
+ <text x="600" y="290" text-anchor="middle" fill="#86efac" font-size="13">CLI · GUI · batch</text>
82
+ <text x="600" y="310" text-anchor="middle" fill="#86efac" font-size="13">local or remote execution</text>
83
83
  <text x="600" y="332" text-anchor="middle" fill="#94a3b8" font-size="12">engineer can watch in real time</text>
84
84
  <text x="600" y="358" text-anchor="middle" fill="#94a3b8" font-size="11">launched once, snippets at will</text>
85
85
 
@@ -51,16 +51,16 @@
51
51
  <text x="430" y="248" font-size="18" font-weight="400" fill="#94a3b8">One CLI. One HTTP protocol. An open driver registry.</text>
52
52
  <text x="430" y="276" font-size="18" font-weight="400" fill="#94a3b8">So AI agents can launch, drive, and observe CAD/CAE jobs.</text>
53
53
 
54
- <!-- chiplets — sample of supported solvers, NOT an exhaustive list -->
54
+ <!-- chiplets — generic plugin capabilities, NOT an exhaustive list -->
55
55
  <g font-size="14" font-weight="600">
56
56
  <rect x="430" y="298" width="78" height="26" rx="13" fill="#1e293b" stroke="#334155"/>
57
- <text x="469" y="316" text-anchor="middle" fill="#93c5fd">Fluent</text>
57
+ <text x="469" y="316" text-anchor="middle" fill="#93c5fd">CLI</text>
58
58
  <rect x="516" y="298" width="78" height="26" rx="13" fill="#1e293b" stroke="#334155"/>
59
- <text x="555" y="316" text-anchor="middle" fill="#c4b5fd">COMSOL</text>
59
+ <text x="555" y="316" text-anchor="middle" fill="#c4b5fd">GUI</text>
60
60
  <rect x="602" y="298" width="84" height="26" rx="13" fill="#1e293b" stroke="#334155"/>
61
- <text x="644" y="316" text-anchor="middle" fill="#86efac">OpenFOAM</text>
61
+ <text x="644" y="316" text-anchor="middle" fill="#86efac">Batch</text>
62
62
  <rect x="694" y="298" width="78" height="26" rx="13" fill="#1e293b" stroke="#334155"/>
63
- <text x="733" y="316" text-anchor="middle" fill="#fda4af">MATLAB</text>
63
+ <text x="733" y="316" text-anchor="middle" fill="#fda4af">Remote</text>
64
64
  <rect x="780" y="298" width="60" height="26" rx="13" fill="#0f172a" stroke="#334155" stroke-dasharray="3 3"/>
65
65
  <text x="810" y="316" text-anchor="middle" fill="#94a3b8">…</text>
66
66
  <rect x="848" y="298" width="120" height="26" rx="13" fill="#1e293b" stroke="#475569"/>
@@ -14,30 +14,36 @@ ruff check src/sim tests
14
14
 
15
15
  ## Adding a new driver
16
16
 
17
- Drop a `DriverProtocol` implementation under `src/sim/drivers/<name>/driver.py` and register it in `_BUILTIN_REGISTRY` inside `drivers/__init__.py`. For an out-of-tree driver, expose it via the `sim.drivers` entry-point group from your own package. See `pybamm/driver.py` for the smallest reference. Persistent-session driver examples live in the out-of-tree plugin packages.
17
+ Every driver ships as its own `sim-plugin-<name>` package — sim-cli core has no built-in drivers. Implement `DriverProtocol` in your plugin package, register it via the `sim.drivers` entry-point group in your `pyproject.toml`:
18
18
 
19
- The server routes all drivers through `DriverProtocol` — no `server.py` changes needed. Set `supports_session = True` for persistent-session drivers, `False` for one-shot only.
19
+ ```toml
20
+ [project.entry-points."sim.drivers"]
21
+ <name> = "sim_plugin_<name>.driver:MyDriver"
22
+ ```
23
+
24
+ Set `supports_session = True` for persistent-session drivers, `False` for one-shot only. The server routes all drivers through `DriverProtocol` — no `server.py` changes needed.
25
+
26
+ Read [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice) for shape: driver implementation + skill packaged together.
20
27
 
21
28
  ## Project layout
22
29
 
23
30
  ```
24
31
  src/sim/
25
- cli.py Click app, all subcommands
26
- server.py FastAPI server (sim serve)
27
- session.py HTTP client used by connect/exec/inspect
28
- driver.py DriverProtocol + result dataclasses
29
- compat.py Version-compat profiles + layered skill resolution
32
+ cli.py Click app, all subcommands
33
+ server.py FastAPI server (sim serve)
34
+ session.py HTTP client used by connect/exec/inspect
35
+ driver.py DriverProtocol + result dataclasses
36
+ compat.py Version-compat profiles + layered skill resolution
37
+ plugins.py Plugin discovery, listing, info
38
+ plugin_catalog.py Catalogue/discovery fetch + normalization
39
+ _plugin_install.py Explicit install / uninstall sources
30
40
  drivers/
31
- pybamm/ Reference: smallest one-shot driver
32
- openfoam/ Reference: SDK-less batch-CLI driver
33
- … one folder per built-in (open-source) backend
34
- __init__.py _BUILTIN_REGISTRY — register new built-in backends
35
- here; external plugins register via the
36
- `sim.drivers` entry-point group from their own
37
- package
38
- tests/ unit tests + fixtures (84 tests)
39
- assets/ logo · banner · architecture (SVG)
40
- docs/ translated READMEs (de · ja · zh) + architecture docs
41
+ __init__.py Plugin registry — discovers external plugins
42
+ via the `sim.drivers` entry-point group at
43
+ import time
44
+ tests/ unit tests + fixtures
45
+ assets/ logo · banner · architecture (SVG)
46
+ docs/ translated READMEs (de · ja · zh) + architecture docs
41
47
  ```
42
48
 
43
49
  ## Dev flags and utilities