sim-cli-core 0.2.4__tar.gz → 0.3.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.
Files changed (140) hide show
  1. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/CLAUDE.md +1 -1
  2. sim_cli_core-0.3.1/NOTICE +35 -0
  3. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/PKG-INFO +78 -22
  4. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/README.md +76 -18
  5. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/assets/architecture.svg +6 -6
  6. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/assets/banner.svg +5 -5
  7. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/DEVELOPMENT.md +22 -17
  8. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/README.zh.md +55 -40
  9. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/agent-readability.md +2 -2
  10. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/architecture/version-compat.md +1 -1
  11. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/plugin-install.md +4 -28
  12. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/pyproject.toml +2 -3
  13. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/_plugin_install.py +88 -9
  14. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/cli.py +69 -3
  15. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/compat.py +22 -0
  16. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/drivers/__init__.py +8 -14
  17. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/inspect.py +48 -12
  18. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/server.py +37 -3
  19. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/session.py +4 -1
  20. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_cli.py +26 -3
  21. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_compat.py +18 -0
  22. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_multi_session.py +41 -1
  23. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_plugin_install.py +152 -0
  24. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_plugins.py +16 -16
  25. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_protocol_conformance.py +1 -11
  26. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/conftest.py +26 -15
  27. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/inspect/test_gui_probes.py +113 -0
  28. sim_cli_core-0.3.1/uv.lock +830 -0
  29. sim_cli_core-0.2.4/NOTICE +0 -72
  30. sim_cli_core-0.2.4/src/sim/drivers/coolprop/__init__.py +0 -3
  31. sim_cli_core-0.2.4/src/sim/drivers/coolprop/driver.py +0 -183
  32. sim_cli_core-0.2.4/src/sim/drivers/openfoam/__init__.py +0 -4
  33. sim_cli_core-0.2.4/src/sim/drivers/openfoam/compatibility.yaml +0 -37
  34. sim_cli_core-0.2.4/src/sim/drivers/openfoam/driver.py +0 -432
  35. sim_cli_core-0.2.4/tests/drivers/coolprop/test_coolprop_driver.py +0 -90
  36. sim_cli_core-0.2.4/tests/drivers/coolprop/test_coolprop_e2e.py +0 -36
  37. sim_cli_core-0.2.4/tests/fixtures/coolprop_good.py +0 -5
  38. sim_cli_core-0.2.4/tests/fixtures/coolprop_no_import.py +0 -1
  39. sim_cli_core-0.2.4/tests/fixtures/coolprop_no_usage.py +0 -2
  40. sim_cli_core-0.2.4/tests/fixtures/coolprop_syntax_error.py +0 -2
  41. sim_cli_core-0.2.4/tests/inspect/__init__.py +0 -0
  42. sim_cli_core-0.2.4/uv.lock +0 -1662
  43. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/.github/workflows/publish.yml +0 -0
  44. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/.gitignore +0 -0
  45. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/CONTRIBUTING.md +0 -0
  46. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/LICENSE +0 -0
  47. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/assets/logo.svg +0 -0
  48. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/README.de.md +0 -0
  49. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/README.ja.md +0 -0
  50. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/architecture/multi-session-and-config.md +0 -0
  51. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/docs/architecture/skills-layering-plan.md +0 -0
  52. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/__init__.py +0 -0
  53. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/__main__.py +0 -0
  54. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/_timeout.py +0 -0
  55. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/config.py +0 -0
  56. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/describe.py +0 -0
  57. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/driver.py +0 -0
  58. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
  59. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/gui/__init__.py +0 -0
  60. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/gui/_pywinauto_tools.py +0 -0
  61. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/gui/_win32_dialog.py +0 -0
  62. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/history.py +0 -0
  63. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/plugins.py +0 -0
  64. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/runner.py +0 -0
  65. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/testing/__init__.py +0 -0
  66. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/src/sim/testing/protocol_conformance.py +0 -0
  67. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/__init__.py +0 -0
  68. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/__init__.py +0 -0
  69. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_config.py +0 -0
  70. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_connect.py +0 -0
  71. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_describe.py +0 -0
  72. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_driver_discovery.py +0 -0
  73. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_history.py +0 -0
  74. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_init_setup.py +0 -0
  75. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_lint.py +0 -0
  76. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_lint_public_corpus.py +0 -0
  77. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_logs.py +0 -0
  78. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/base/test_run.py +0 -0
  79. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/drivers/__init__.py +0 -0
  80. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/calculix_e2e_cantilever_run.py +0 -0
  81. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/coolprop/water_props.py +0 -0
  82. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/elmer_e2e_heat_square.py +0 -0
  83. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/gmsh_e2e_sphere_mesh.py +0 -0
  84. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/lammps_e2e_lj_nvt.py +0 -0
  85. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/meshio_e2e_gmsh_to_vtk.py +0 -0
  86. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/pymfem_e2e_poisson.py +0 -0
  87. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/pyvista_e2e_sphere_stats.py +0 -0
  88. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/scikit_fem_e2e_poisson.py +0 -0
  89. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/scikitrf/short_load.py +0 -0
  90. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/execution/su2_e2e_inviscid_bump.py +0 -0
  91. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/comsol/comsol_good.py +0 -0
  92. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/comsol/comsol_no_client.py +0 -0
  93. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/comsol/comsol_no_import.py +0 -0
  94. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/hypermesh_good.py +0 -0
  95. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/hypermesh_gui.py +0 -0
  96. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/hypermesh_no_import.py +0 -0
  97. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/hypermesh_no_usage.py +0 -0
  98. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/hypermesh_syntax_error.py +0 -0
  99. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/bad_import_order.py +0 -0
  100. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/bad_no_close.py +0 -0
  101. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/bad_no_simapp.py +0 -0
  102. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/hello_world.py +0 -0
  103. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/import_franka.py +0 -0
  104. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/not_isaac.py +0 -0
  105. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/official_hello_world.py +0 -0
  106. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/replicator_cubes.py +0 -0
  107. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/syntax_error.py +0 -0
  108. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/isaac/warehouse_sdg.py +0 -0
  109. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/matlab/empty_model.mdl +0 -0
  110. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/matlab/empty_model.slx +0 -0
  111. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/matlab/matlab_ok.m +0 -0
  112. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/mfem_good.py +0 -0
  113. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/mfem_no_import.py +0 -0
  114. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/mfem_no_mesh.py +0 -0
  115. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/mfem_syntax_error.py +0 -0
  116. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/mock_fail.py +0 -0
  117. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/mock_solver.py +0 -0
  118. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/newton/basic_pendulum.json +0 -0
  119. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/newton/cable_twist.py +0 -0
  120. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/newton/robot_g1.json +0 -0
  121. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/not_simulation.py +0 -0
  122. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/pybamm/pybamm_bad_import.py +0 -0
  123. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/pybamm/pybamm_crate_sweep.py +0 -0
  124. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/pybamm/pybamm_no_solve.py +0 -0
  125. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/pybamm/pybamm_spm_good.py +0 -0
  126. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/skfem_good.py +0 -0
  127. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/skfem_no_import.py +0 -0
  128. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/skfem_no_solve.py +0 -0
  129. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/fixtures/skfem_syntax_error.py +0 -0
  130. {sim_cli_core-0.2.4/tests/drivers/coolprop → sim_cli_core-0.3.1/tests/gui}/__init__.py +0 -0
  131. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/gui/test_connect_tools_field.py +0 -0
  132. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/gui/test_gui_facade.py +0 -0
  133. {sim_cli_core-0.2.4/tests/gui → sim_cli_core-0.3.1/tests/inspect}/__init__.py +0 -0
  134. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/inspect/_extract_comsol_Tmax.py +0 -0
  135. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/inspect/test_channel_3_4_5_9.py +0 -0
  136. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/inspect/test_inspect_types.py +0 -0
  137. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/inspect/test_probes.py +0 -0
  138. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tests/inspect/test_snippet_timeout.py +0 -0
  139. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tools/extract_driver.py +0 -0
  140. {sim_cli_core-0.2.4 → sim_cli_core-0.3.1}/tools/lint-public-corpus.py +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.2.4
3
+ Version: 0.3.1
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
@@ -11,7 +11,7 @@ Author-email: Weiqi Ji <jiweiqi10@gmail.com>
11
11
  License-Expression: Apache-2.0
12
12
  License-File: LICENSE
13
13
  License-File: NOTICE
14
- Keywords: agent,agentic,cad,cae,cfd,coolprop,fea,llm,openfoam,simulation
14
+ Keywords: agent,agentic,cad,cae,cfd,fea,llm,out-of-tree,plugins,simulation
15
15
  Classifier: Development Status :: 3 - Alpha
16
16
  Classifier: Intended Audience :: Developers
17
17
  Classifier: Intended Audience :: Science/Research
@@ -36,8 +36,6 @@ Requires-Dist: uvicorn>=0.34
36
36
  Provides-Extra: dev
37
37
  Requires-Dist: pytest>=8.0; extra == 'dev'
38
38
  Requires-Dist: ruff>=0.4; extra == 'dev'
39
- Provides-Extra: pybamm
40
- Requires-Dist: pybamm>=24.0; extra == 'pybamm'
41
39
  Description-Content-Type: text/markdown
42
40
 
43
41
  <div align="center">
@@ -68,7 +66,7 @@ Description-Content-Type: text/markdown
68
66
 
69
67
  **English** · [Deutsch](docs/README.de.md) · [日本語](docs/README.ja.md) · [中文](docs/README.zh.md)
70
68
 
71
- [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)
72
70
 
73
71
  </div>
74
72
 
@@ -116,6 +114,10 @@ For the full driver protocol, server endpoints, and execution pipeline see [CLAU
116
114
 
117
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.
118
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
+
119
121
  ```bash
120
122
  # 1. On the host that has the solver installed, install sim core only
121
123
  # — no driver choice yet:
@@ -123,7 +125,7 @@ uv pip install sim-cli-core
123
125
 
124
126
  # 2. Install the plugin for the solver you actually want (browse the
125
127
  # index with `sim plugin list`):
126
- sim plugin install <solver> # e.g. ltspice, coolprop, pybamm
128
+ sim plugin install <solver> # e.g. ltspice
127
129
 
128
130
  # 3. Tell sim to look at this machine and pick the right SDK profile:
129
131
  sim check <solver>
@@ -144,6 +146,34 @@ sim --host <server-ip> screenshot -o shot.png
144
146
  sim --host <server-ip> disconnect
145
147
  ```
146
148
 
149
+ **Windows (PowerShell):**
150
+
151
+ ```powershell
152
+ # 1. On the host that has the solver installed, install sim core only
153
+ # — no driver choice yet:
154
+ uv pip install sim-cli-core
155
+
156
+ # 2. Install the plugin for the solver you actually want (browse the
157
+ # index with `sim plugin list`):
158
+ sim plugin install <solver> # e.g. ltspice
159
+
160
+ # 3. Tell sim to look at this machine and pick the right SDK profile:
161
+ sim check <solver>
162
+
163
+ # 4. Bootstrap that profile env (or pass --auto-install to step 5):
164
+ sim env install <profile>
165
+
166
+ # 5. Start the server (only needed for remote / cross-machine workflows):
167
+ sim serve --host 0.0.0.0 # FastAPI on :7600
168
+
169
+ # 6. From the agent / your laptop / anywhere on the network:
170
+ sim --host <server-ip> connect --solver <solver> --mode solver --ui-mode gui
171
+ sim --host <server-ip> inspect session.versions # ← always do this first
172
+ sim --host <server-ip> exec "<solver-specific snippet>"
173
+ sim --host <server-ip> screenshot -o shot.png
174
+ sim --host <server-ip> disconnect
175
+ ```
176
+
147
177
  That's the full loop: **detect → bootstrap → launch → drive → observe → tear down** — with the engineer optionally watching the solver GUI in real time.
148
178
 
149
179
  > **Why the bootstrap step?** Each `(solver, SDK, driver, skill)` combo is
@@ -156,30 +186,56 @@ That's the full loop: **detect → bootstrap → launch → drive → observe
156
186
 
157
187
  ---
158
188
 
189
+ ## 📦 Plugin index
190
+
191
+ `sim plugin install <name>` resolves names against two indexes, in order:
192
+
193
+ 1. **svd-maintained wheel manifest** at `https://cdn.svdailab.com/manifest.json` — pre-built wheels published by the project. Anonymous GET, updated whenever a new wheel ships.
194
+ 2. **Community-maintained catalogue** at [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index) — broader plugin listing maintained by the community; entries can be OSS or third-party plugins, pointing at GitHub releases or git+https sources.
195
+
196
+ The first hit wins. Most users never see this distinction — `sim plugin install ltspice` just works.
197
+
198
+ svd manifest schema (the community catalogue uses a different shape — see its repo):
199
+
200
+ ```json
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
+ }
210
+ ```
211
+
212
+ To install a wheel directly without going through the resolver, hand `sim plugin install` the URL — `sim plugin install https://cdn.svdailab.com/wheels/<file>.whl`.
213
+
214
+ ---
215
+
159
216
  ## 🧪 Solver registry
160
217
 
161
- `sim-cli` core is **solver-agnostic** — it ships with one OSS driver as a built-in (`openfoam`), and every other solver 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.
218
+ `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.
162
219
 
163
- 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:
220
+ `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
+
222
+ Install by name (the resolver chains the svd manifest then the community catalogue — see [Plugin index](#-plugin-index)):
164
223
 
165
224
  ```bash
166
- sim plugin list # what the curated index advertises
225
+ sim plugin list # show installed plugins
167
226
  sim plugin install <name> # e.g. sim plugin install ltspice
168
227
  ```
169
228
 
170
- 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).
229
+ Reference implementation to read for shape: [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice).
171
230
 
172
- Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
231
+ **Private plugins** (vendor-IP-sensitive backends not in the public index) install directly by URL — same `sim plugin install` flow:
173
232
 
174
- ---
175
-
176
- ## 🎬 Demo
177
-
178
- > 📺 **Early preview:** [first walkthrough on YouTube](https://www.youtube.com/watch?v=3Fg6Oph44Ik) — rough cut, a polished recording is still wanted (see below).
233
+ ```bash
234
+ sim plugin install git+https://github.com/<org>/sim-plugin-<name>
235
+ # (you need read-access to the repo; without it, git clone returns 401)
236
+ ```
179
237
 
180
- > **Recording in progress.** A short terminal capture of `sim connect → exec → inspect → screenshot` against a live solver session will land here.
181
- >
182
- > 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`.
238
+ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
183
239
 
184
240
  ---
185
241
 
@@ -194,7 +250,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
194
250
  ### 🔌 Solver-agnostic
195
251
  - **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
196
252
  - **Persistent + one-shot** from the same CLI — no separate client per mode
197
- - **Open plugin index** — discoverable via `sim plugin list`; curated registry at [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)
253
+ - **Plugin index** — `sim plugin install <name>` chains an [svd-maintained wheel manifest](https://cdn.svdailab.com/manifest.json) and a [community-maintained catalogue](https://github.com/svd-ai-lab/sim-plugin-index)
198
254
  - **Companion skills** in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) so an LLM picks up each new backend without prior context
199
255
 
200
256
  ### 🌐 Remote-friendly
@@ -208,7 +264,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
208
264
 
209
265
  | Command | What it does | Analogy |
210
266
  |---|---|---|
211
- | `sim plugin list / install / uninstall` | Manage out-of-tree solver plugins from the curated index | `npm install` |
267
+ | `sim plugin list / install / uninstall` | Manage solver plugins (resolver chains svd → community index) | `npm install` |
212
268
  | `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
213
269
  | `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
214
270
  | `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
@@ -284,7 +340,7 @@ That is the entire setup — same `sim-cli-core` package on both sides, same wir
284
340
 
285
341
  ## 🔗 Related projects
286
342
 
287
- - **[`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
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`)
288
344
  - **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
289
345
  - **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
290
346
 
@@ -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,6 +74,10 @@ 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:
@@ -81,7 +85,7 @@ uv pip install sim-cli-core
81
85
 
82
86
  # 2. Install the plugin for the solver you actually want (browse the
83
87
  # index with `sim plugin list`):
84
- sim plugin install <solver> # e.g. ltspice, coolprop, pybamm
88
+ sim plugin install <solver> # e.g. ltspice
85
89
 
86
90
  # 3. Tell sim to look at this machine and pick the right SDK profile:
87
91
  sim check <solver>
@@ -102,6 +106,34 @@ sim --host <server-ip> screenshot -o shot.png
102
106
  sim --host <server-ip> disconnect
103
107
  ```
104
108
 
109
+ **Windows (PowerShell):**
110
+
111
+ ```powershell
112
+ # 1. On the host that has the solver installed, install sim core only
113
+ # — no driver choice yet:
114
+ uv pip install sim-cli-core
115
+
116
+ # 2. Install the plugin for the solver you actually want (browse the
117
+ # index with `sim plugin list`):
118
+ sim plugin install <solver> # e.g. ltspice
119
+
120
+ # 3. Tell sim to look at this machine and pick the right SDK profile:
121
+ sim check <solver>
122
+
123
+ # 4. Bootstrap that profile env (or pass --auto-install to step 5):
124
+ sim env install <profile>
125
+
126
+ # 5. Start the server (only needed for remote / cross-machine workflows):
127
+ sim serve --host 0.0.0.0 # FastAPI on :7600
128
+
129
+ # 6. From the agent / your laptop / anywhere on the network:
130
+ sim --host <server-ip> connect --solver <solver> --mode solver --ui-mode gui
131
+ sim --host <server-ip> inspect session.versions # ← always do this first
132
+ sim --host <server-ip> exec "<solver-specific snippet>"
133
+ sim --host <server-ip> screenshot -o shot.png
134
+ sim --host <server-ip> disconnect
135
+ ```
136
+
105
137
  That's the full loop: **detect → bootstrap → launch → drive → observe → tear down** — with the engineer optionally watching the solver GUI in real time.
106
138
 
107
139
  > **Why the bootstrap step?** Each `(solver, SDK, driver, skill)` combo is
@@ -114,30 +146,56 @@ That's the full loop: **detect → bootstrap → launch → drive → observe
114
146
 
115
147
  ---
116
148
 
149
+ ## 📦 Plugin index
150
+
151
+ `sim plugin install <name>` resolves names against two indexes, in order:
152
+
153
+ 1. **svd-maintained wheel manifest** at `https://cdn.svdailab.com/manifest.json` — pre-built wheels published by the project. Anonymous GET, updated whenever a new wheel ships.
154
+ 2. **Community-maintained catalogue** at [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index) — broader plugin listing maintained by the community; entries can be OSS or third-party plugins, pointing at GitHub releases or git+https sources.
155
+
156
+ The first hit wins. Most users never see this distinction — `sim plugin install ltspice` just works.
157
+
158
+ svd manifest schema (the community catalogue uses a different shape — see its repo):
159
+
160
+ ```json
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
+ }
170
+ ```
171
+
172
+ To install a wheel directly without going through the resolver, hand `sim plugin install` the URL — `sim plugin install https://cdn.svdailab.com/wheels/<file>.whl`.
173
+
174
+ ---
175
+
117
176
  ## 🧪 Solver registry
118
177
 
119
- `sim-cli` core is **solver-agnostic** — it ships with one OSS driver as a built-in (`openfoam`), and every other solver 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.
178
+ `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.
120
179
 
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:
180
+ `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
+
182
+ Install by name (the resolver chains the svd manifest then the community catalogue — see [Plugin index](#-plugin-index)):
122
183
 
123
184
  ```bash
124
- sim plugin list # what the curated index advertises
185
+ sim plugin list # show installed plugins
125
186
  sim plugin install <name> # e.g. sim plugin install ltspice
126
187
  ```
127
188
 
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).
189
+ Reference implementation to read for shape: [`sim-plugin-ltspice`](https://github.com/svd-ai-lab/sim-plugin-ltspice).
129
190
 
130
- Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
191
+ **Private plugins** (vendor-IP-sensitive backends not in the public index) install directly by URL — same `sim plugin install` flow:
131
192
 
132
- ---
133
-
134
- ## 🎬 Demo
135
-
136
- > 📺 **Early preview:** [first walkthrough on YouTube](https://www.youtube.com/watch?v=3Fg6Oph44Ik) — rough cut, a polished recording is still wanted (see below).
193
+ ```bash
194
+ sim plugin install git+https://github.com/<org>/sim-plugin-<name>
195
+ # (you need read-access to the repo; without it, git clone returns 401)
196
+ ```
137
197
 
138
- > **Recording in progress.** A short terminal capture of `sim connect → exec → inspect → screenshot` against a live solver session will land here.
139
- >
140
- > 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`.
198
+ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) and the per-plugin repos.
141
199
 
142
200
  ---
143
201
 
@@ -152,7 +210,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
152
210
  ### 🔌 Solver-agnostic
153
211
  - **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
154
212
  - **Persistent + one-shot** from the same CLI — no separate client per mode
155
- - **Open plugin index** — discoverable via `sim plugin list`; curated registry at [`sim-plugin-index`](https://github.com/svd-ai-lab/sim-plugin-index)
213
+ - **Plugin index** — `sim plugin install <name>` chains an [svd-maintained wheel manifest](https://cdn.svdailab.com/manifest.json) and a [community-maintained catalogue](https://github.com/svd-ai-lab/sim-plugin-index)
156
214
  - **Companion skills** in [`sim-skills`](https://github.com/svd-ai-lab/sim-skills) so an LLM picks up each new backend without prior context
157
215
 
158
216
  ### 🌐 Remote-friendly
@@ -166,7 +224,7 @@ Per-solver protocols, snippets, and demo workflows live in [`sim-skills`](https:
166
224
 
167
225
  | Command | What it does | Analogy |
168
226
  |---|---|---|
169
- | `sim plugin list / install / uninstall` | Manage out-of-tree solver plugins from the curated index | `npm install` |
227
+ | `sim plugin list / install / uninstall` | Manage solver plugins (resolver chains svd → community index) | `npm install` |
170
228
  | `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
171
229
  | `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
172
230
  | `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
@@ -242,7 +300,7 @@ That is the entire setup — same `sim-cli-core` package on both sides, same wir
242
300
 
243
301
  ## 🔗 Related projects
244
302
 
245
- - **[`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
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`)
246
304
  - **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
247
305
  - **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
248
306
 
@@ -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,35 @@ 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_install.py Install / uninstall / index resolution
30
39
  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
40
+ __init__.py Plugin registry — discovers external plugins
41
+ via the `sim.drivers` entry-point group at
42
+ import time
43
+ tests/ unit tests + fixtures
44
+ assets/ logo · banner · architecture (SVG)
45
+ docs/ translated READMEs (de · ja · zh) + architecture docs
41
46
  ```
42
47
 
43
48
  ## Dev flags and utilities