sim-cli-core 0.2.4__py3-none-any.whl
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/__init__.py +11 -0
- sim/__main__.py +24 -0
- sim/_plugin_install.py +451 -0
- sim/_timeout.py +115 -0
- sim/cli.py +1353 -0
- sim/compat.py +411 -0
- sim/config.py +380 -0
- sim/describe.py +346 -0
- sim/driver.py +190 -0
- sim/drivers/__init__.py +161 -0
- sim/drivers/coolprop/__init__.py +3 -0
- sim/drivers/coolprop/driver.py +183 -0
- sim/drivers/openfoam/__init__.py +4 -0
- sim/drivers/openfoam/compatibility.yaml +37 -0
- sim/drivers/openfoam/driver.py +432 -0
- sim/gui/LICENSES/ATTRIBUTION.md +24 -0
- sim/gui/__init__.py +230 -0
- sim/gui/_pywinauto_tools.py +452 -0
- sim/gui/_win32_dialog.py +148 -0
- sim/history.py +170 -0
- sim/inspect.py +1088 -0
- sim/plugins.py +468 -0
- sim/runner.py +195 -0
- sim/server.py +547 -0
- sim/session.py +224 -0
- sim/testing/__init__.py +30 -0
- sim/testing/protocol_conformance.py +264 -0
- sim_cli_core-0.2.4.dist-info/METADATA +309 -0
- sim_cli_core-0.2.4.dist-info/RECORD +33 -0
- sim_cli_core-0.2.4.dist-info/WHEEL +4 -0
- sim_cli_core-0.2.4.dist-info/entry_points.txt +2 -0
- sim_cli_core-0.2.4.dist-info/licenses/LICENSE +190 -0
- sim_cli_core-0.2.4.dist-info/licenses/NOTICE +72 -0
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sim-cli-core
|
|
3
|
+
Version: 0.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
|
+
Project-URL: Homepage, https://github.com/svd-ai-lab/sim-cli
|
|
6
|
+
Project-URL: Repository, https://github.com/svd-ai-lab/sim-cli
|
|
7
|
+
Project-URL: Issues, https://github.com/svd-ai-lab/sim-cli/issues
|
|
8
|
+
Project-URL: Documentation, https://github.com/svd-ai-lab/sim-cli#readme
|
|
9
|
+
Project-URL: Changelog, https://github.com/svd-ai-lab/sim-cli/blob/main/CHANGELOG.md
|
|
10
|
+
Author-email: Weiqi Ji <jiweiqi10@gmail.com>
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
License-File: NOTICE
|
|
14
|
+
Keywords: agent,agentic,cad,cae,cfd,coolprop,fea,llm,openfoam,simulation
|
|
15
|
+
Classifier: Development Status :: 3 - Alpha
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Intended Audience :: Science/Research
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering
|
|
24
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
25
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
26
|
+
Requires-Python: >=3.10
|
|
27
|
+
Requires-Dist: click>=8.0
|
|
28
|
+
Requires-Dist: fastapi>=0.115
|
|
29
|
+
Requires-Dist: httpx>=0.28
|
|
30
|
+
Requires-Dist: lxml>=5.0
|
|
31
|
+
Requires-Dist: pillow>=10
|
|
32
|
+
Requires-Dist: pywinauto>=0.6.8; sys_platform == 'win32'
|
|
33
|
+
Requires-Dist: pyyaml>=6.0
|
|
34
|
+
Requires-Dist: tomli>=2.0; python_version < '3.11'
|
|
35
|
+
Requires-Dist: uvicorn>=0.34
|
|
36
|
+
Provides-Extra: dev
|
|
37
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
38
|
+
Requires-Dist: ruff>=0.4; extra == 'dev'
|
|
39
|
+
Provides-Extra: pybamm
|
|
40
|
+
Requires-Dist: pybamm>=24.0; extra == 'pybamm'
|
|
41
|
+
Description-Content-Type: text/markdown
|
|
42
|
+
|
|
43
|
+
<div align="center">
|
|
44
|
+
|
|
45
|
+
<img src="assets/banner.svg" alt="sim — the container runtime for physics simulations" width="820">
|
|
46
|
+
|
|
47
|
+
<br>
|
|
48
|
+
|
|
49
|
+
**Make every engineering tool agent-native.**
|
|
50
|
+
|
|
51
|
+
*Today's CAD and CAE software was built for engineers clicking through GUIs.*
|
|
52
|
+
*Tomorrow's user is an LLM agent — and it needs a way in.*
|
|
53
|
+
|
|
54
|
+
<p align="center">
|
|
55
|
+
<a href="#-quick-start"><img src="https://img.shields.io/badge/Quick_Start-2_min-3b82f6?style=for-the-badge" alt="Quick Start"></a>
|
|
56
|
+
<a href="#-solver-registry"><img src="https://img.shields.io/badge/Solvers-growing_registry-22c55e?style=for-the-badge" alt="Growing solver registry"></a>
|
|
57
|
+
<a href="https://github.com/svd-ai-lab/sim-skills"><img src="https://img.shields.io/badge/Agent_Skills-sim--skills-8b5cf6?style=for-the-badge" alt="Companion skills"></a>
|
|
58
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-eab308?style=for-the-badge" alt="License"></a>
|
|
59
|
+
</p>
|
|
60
|
+
|
|
61
|
+
<p align="center">
|
|
62
|
+
<img src="https://img.shields.io/badge/python-3.10--3.12-3776AB?logo=python&logoColor=white" alt="Python">
|
|
63
|
+
<img src="https://img.shields.io/badge/CLI-Click_8-blue" alt="Click">
|
|
64
|
+
<img src="https://img.shields.io/badge/server-FastAPI-009688?logo=fastapi&logoColor=white" alt="FastAPI">
|
|
65
|
+
<img src="https://img.shields.io/badge/transport-HTTP%2FJSON-orange" alt="HTTP/JSON">
|
|
66
|
+
<img src="https://img.shields.io/badge/status-alpha-f97316" alt="Status: alpha">
|
|
67
|
+
</p>
|
|
68
|
+
|
|
69
|
+
**English** · [Deutsch](docs/README.de.md) · [日本語](docs/README.ja.md) · [中文](docs/README.zh.md)
|
|
70
|
+
|
|
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)
|
|
72
|
+
|
|
73
|
+
</div>
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 🤔 Why sim?
|
|
78
|
+
|
|
79
|
+
LLM agents already know how to write simulation scripts — training data is full of them. What they *don't* have is a standard way to **launch a solver, drive it step by step, and observe what happened** before deciding the next move.
|
|
80
|
+
|
|
81
|
+
Today, the choices are awful:
|
|
82
|
+
|
|
83
|
+
- **Fire-and-forget scripts** — agent writes 200 lines, runs the whole thing, an error at line 30 surfaces as garbage at line 200, no introspection, no recovery.
|
|
84
|
+
- **Bespoke wrappers per solver** — every team rebuilds the same launch / exec / inspect / teardown loop in a different shape.
|
|
85
|
+
- **Closed proprietary glue** — vendor SDKs that don't compose, don't share a vocabulary, and don't speak HTTP.
|
|
86
|
+
|
|
87
|
+
`sim` is the missing layer:
|
|
88
|
+
|
|
89
|
+
- **One CLI**, one HTTP protocol, **a growing driver registry** spanning CFD, multiphysics, thermal, pre-processing, and beyond.
|
|
90
|
+
- **Persistent sessions** the agent introspects between every step.
|
|
91
|
+
- **Remote-by-default** — the CLI client and the live solver can sit on different machines (LAN, Tailscale, HPC head node).
|
|
92
|
+
- **Companion agent skills** that teach an LLM how to drive each backend safely.
|
|
93
|
+
|
|
94
|
+
> Like a container runtime standardized how Kubernetes talks to containers, **sim** standardizes how agents talk to solvers.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 🏛 Architecture
|
|
99
|
+
|
|
100
|
+
<div align="center">
|
|
101
|
+
<img src="assets/architecture.svg" alt="sim architecture: CLI client over HTTP/JSON to a sim serve FastAPI process holding a live solver session" width="900">
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
Two execution modes from the same CLI, sharing the same `DriverProtocol`:
|
|
105
|
+
|
|
106
|
+
| Mode | Command | When to use it |
|
|
107
|
+
|---|---|---|
|
|
108
|
+
| **Persistent session** | `sim serve` + `sim connect / exec / inspect` | Long, stateful workflows the agent inspects between steps |
|
|
109
|
+
| **One-shot** | `sim run script.py --solver X` | Whole-script jobs you want stored as a numbered run in `.sim/runs/` |
|
|
110
|
+
|
|
111
|
+
For the full driver protocol, server endpoints, and execution pipeline see [CLAUDE.md](CLAUDE.md).
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## 🚀 Quick Start
|
|
116
|
+
|
|
117
|
+
> **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
|
+
|
|
119
|
+
```bash
|
|
120
|
+
# 1. On the host that has the solver installed, install sim core only
|
|
121
|
+
# — no driver choice yet:
|
|
122
|
+
uv pip install sim-cli-core
|
|
123
|
+
|
|
124
|
+
# 2. Install the plugin for the solver you actually want (browse the
|
|
125
|
+
# index with `sim plugin list`):
|
|
126
|
+
sim plugin install <solver> # e.g. ltspice, coolprop, pybamm
|
|
127
|
+
|
|
128
|
+
# 3. Tell sim to look at this machine and pick the right SDK profile:
|
|
129
|
+
sim check <solver>
|
|
130
|
+
# → reports detected installs of <solver> and the profile they resolve to
|
|
131
|
+
|
|
132
|
+
# 4. Bootstrap that profile env (creates .sim/envs/<profile>/ with the
|
|
133
|
+
# pinned SDK; or pass --auto-install to step 5 to do it inline):
|
|
134
|
+
sim env install <profile>
|
|
135
|
+
|
|
136
|
+
# 5. Start the server (only needed for remote / cross-machine workflows):
|
|
137
|
+
sim serve --host 0.0.0.0 # FastAPI on :7600
|
|
138
|
+
|
|
139
|
+
# 6. From the agent / your laptop / anywhere on the network:
|
|
140
|
+
sim --host <server-ip> connect --solver <solver> --mode solver --ui-mode gui
|
|
141
|
+
sim --host <server-ip> inspect session.versions # ← always do this first
|
|
142
|
+
sim --host <server-ip> exec "<solver-specific snippet>"
|
|
143
|
+
sim --host <server-ip> screenshot -o shot.png
|
|
144
|
+
sim --host <server-ip> disconnect
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
That's the full loop: **detect → bootstrap → launch → drive → observe → tear down** — with the engineer optionally watching the solver GUI in real time.
|
|
148
|
+
|
|
149
|
+
> **Why the bootstrap step?** Each `(solver, SDK, driver, skill)` combo is
|
|
150
|
+
> its own compatibility universe — different solver releases may want
|
|
151
|
+
> different SDK versions, and those SDK versions can't always coexist in
|
|
152
|
+
> one Python env. sim treats each combo as an isolated "profile env" so
|
|
153
|
+
> you can keep multiple versions on one machine without dependency
|
|
154
|
+
> conflicts. The contract is in
|
|
155
|
+
> [`docs/architecture/version-compat.md`](docs/architecture/version-compat.md).
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## 🧪 Solver registry
|
|
160
|
+
|
|
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.
|
|
162
|
+
|
|
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:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
sim plugin list # what the curated index advertises
|
|
167
|
+
sim plugin install <name> # e.g. sim plugin install ltspice
|
|
168
|
+
```
|
|
169
|
+
|
|
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).
|
|
171
|
+
|
|
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.
|
|
173
|
+
|
|
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).
|
|
179
|
+
|
|
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`.
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## ✨ Features
|
|
187
|
+
|
|
188
|
+
### 🧠 Built for agents
|
|
189
|
+
- **Persistent sessions** that survive across snippets — never restart the solver mid-task
|
|
190
|
+
- **Step-by-step introspection** with `sim inspect` between every action
|
|
191
|
+
- **Pre-flight `sim lint`** catches missing imports and unsupported APIs before launch
|
|
192
|
+
- **Numbered run history** in `.sim/runs/` for one-shot jobs, browsable via `sim logs`
|
|
193
|
+
|
|
194
|
+
### 🔌 Solver-agnostic
|
|
195
|
+
- **One protocol** (`DriverProtocol`) — every driver is ~200 LOC, shipped as its own `sim-plugin-<name>` package via Python entry points
|
|
196
|
+
- **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)
|
|
198
|
+
- **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
|
+
|
|
200
|
+
### 🌐 Remote-friendly
|
|
201
|
+
- **HTTP/JSON transport** — runs anywhere `httpx` runs
|
|
202
|
+
- **Client / server split** — agent on a laptop, solver on an HPC node, GUI on a workstation
|
|
203
|
+
- **Tailscale-ready** — designed for cross-network mesh deployments
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## ⚙️ Commands
|
|
208
|
+
|
|
209
|
+
| Command | What it does | Analogy |
|
|
210
|
+
|---|---|---|
|
|
211
|
+
| `sim plugin list / install / uninstall` | Manage out-of-tree solver plugins from the curated index | `npm install` |
|
|
212
|
+
| `sim check <solver>` | Detect installations + resolve a profile | `docker info` |
|
|
213
|
+
| `sim env install <profile>` | Bootstrap a profile env (venv + pinned SDK) | `pyenv install` |
|
|
214
|
+
| `sim env list [--catalogue]` | Show bootstrapped envs (and the full catalogue) | `pyenv versions` |
|
|
215
|
+
| `sim env remove <profile>` | Tear down a profile env | `pyenv uninstall` |
|
|
216
|
+
| `sim serve` | Start the HTTP server (for cross-machine use) | `ollama serve` |
|
|
217
|
+
| `sim connect` | Launch a solver, open a session | `docker start` |
|
|
218
|
+
| `sim exec` | Run a Python snippet inside the live session | `docker exec` |
|
|
219
|
+
| `sim inspect` | Query live session state (incl. `session.versions`) | `docker inspect` |
|
|
220
|
+
| `sim ps` | Show the active session and its profile | `docker ps` |
|
|
221
|
+
| `sim screenshot` | Grab a PNG of the solver GUI | — |
|
|
222
|
+
| `sim disconnect` | Tear down the session | `docker stop` |
|
|
223
|
+
| `sim stop` | Stop the sim-server process | `docker rm -f` |
|
|
224
|
+
| `sim run` | One-shot script execution | `docker run` |
|
|
225
|
+
| `sim lint` | Pre-flight static check on a script | `ruff check` |
|
|
226
|
+
| `sim logs` | Browse stored run history | `docker logs` |
|
|
227
|
+
|
|
228
|
+
Every command that touches a host (`check`, `env`, `connect`, `exec`, `inspect`, `disconnect`) accepts `--host <ip>` and runs against a remote `sim serve` instead of the local machine.
|
|
229
|
+
|
|
230
|
+
Environment: `SIM_HOST`, `SIM_PORT` for the client; `SIM_DIR` (default `.sim/`) for run storage and profile envs.
|
|
231
|
+
|
|
232
|
+
### Choosing a profile
|
|
233
|
+
|
|
234
|
+
You don't usually have to. `sim check <solver>` tells you which profile your installed solver maps to, and `sim connect ... --auto-install` will bootstrap it for you on first use. The escape hatches:
|
|
235
|
+
|
|
236
|
+
- **Pin a specific profile:** `sim connect --solver <solver> --profile <profile>`
|
|
237
|
+
- **Skip the profile env entirely (legacy / tests):** `sim connect --solver <solver> --inline`
|
|
238
|
+
- **Power-user single-env install:** install the matching plugin package directly into your current venv (e.g. `pip install <plugin-package>`). Skips `sim env` entirely; OK when you only need one solver version on this machine.
|
|
239
|
+
|
|
240
|
+
The full design is in [`docs/architecture/version-compat.md`](docs/architecture/version-compat.md).
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 🆚 Why not just run scripts?
|
|
245
|
+
|
|
246
|
+
| Fire-and-forget script | sim |
|
|
247
|
+
|---|---|
|
|
248
|
+
| Write the whole thing, run, hope it converges | Connect → execute → observe → decide next step |
|
|
249
|
+
| An error at step 2 surfaces at step 12 | Each step verified before the next is sent |
|
|
250
|
+
| Agent has no view of solver state | `sim inspect` between every action |
|
|
251
|
+
| Solver restarts on every iteration | One persistent session, snippets at will |
|
|
252
|
+
| GUI invisible to the human | Engineer watches the GUI while the agent drives |
|
|
253
|
+
| Output parsing reinvented per project | `driver.parse_output()` returns structured fields |
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## 🛠 Development
|
|
258
|
+
|
|
259
|
+
See [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md) for setup, project layout, adding drivers, dev flags, and the layered skill system.
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## 🌐 Remote deployment
|
|
264
|
+
|
|
265
|
+
When the solver lives on a different machine (an HPC login node, a lab box, or any host with the solver installed) and you want to drive it from your laptop, a notebook, or an LLM agent — install `sim-cli-core` on **both** ends and run `sim serve` on the remote.
|
|
266
|
+
|
|
267
|
+
```bash
|
|
268
|
+
# On the solver host (the machine with the solver installed)
|
|
269
|
+
ssh user@solver-host
|
|
270
|
+
pip install sim-cli-core
|
|
271
|
+
sim serve --host 0.0.0.0 --port 7600 # bind to all interfaces
|
|
272
|
+
|
|
273
|
+
# On your local control machine
|
|
274
|
+
sim --host <solver-host-ip> connect --solver <solver> --mode <mode>
|
|
275
|
+
sim --host <solver-host-ip> exec "<solver-specific snippet>"
|
|
276
|
+
sim --host <solver-host-ip> inspect session.summary
|
|
277
|
+
sim --host <solver-host-ip> disconnect
|
|
278
|
+
sim --host <solver-host-ip> stop # shut down the remote server when done
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
That is the entire setup — same `sim-cli-core` package on both sides, same wire protocol whether it is talking to a local or a remote server. Bind `--host 0.0.0.0` only on networks you trust (Tailscale, VPN, LAN behind a firewall); there is **no auth layer** on `/connect` and `/exec` execute arbitrary Python.
|
|
282
|
+
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
## 🔗 Related projects
|
|
286
|
+
|
|
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
|
|
288
|
+
- **[`sim-skills`](https://github.com/svd-ai-lab/sim-skills)** — agent skills, snippets, and demo workflows for each supported solver
|
|
289
|
+
- **[`sim-ltspice`](https://github.com/svd-ai-lab/sim-ltspice)** — standalone Python API for LTspice file formats (used by `sim-plugin-ltspice`)
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## 📄 License
|
|
294
|
+
|
|
295
|
+
Apache-2.0 — see [LICENSE](LICENSE).
|
|
296
|
+
|
|
297
|
+
### Third-party solver SDKs
|
|
298
|
+
|
|
299
|
+
`sim-cli` is a thin wrapper/runtime — it does **not** bundle or redistribute any vendor solver or vendor SDK. Each solver backend is reached through a third-party SDK that the user installs separately via `sim env install` or as an optional extra.
|
|
300
|
+
|
|
301
|
+
Users are responsible for obtaining a valid license for each underlying solver and for complying with the license, copyright, and EULA of every third-party SDK they choose to install alongside `sim-cli`. See [`NOTICE`](NOTICE) for the list of optional SDK dependencies and their upstream locations.
|
|
302
|
+
|
|
303
|
+
### Trademarks
|
|
304
|
+
|
|
305
|
+
`sim-cli` is an independent open-source project and is **not affiliated with, endorsed by, or sponsored by** any solver vendor. Product, solver, and company names referenced anywhere in this repository remain the property of their respective owners:
|
|
306
|
+
|
|
307
|
+
- **OpenFOAM®** is a registered trademark of **OpenCFD Ltd.**
|
|
308
|
+
- **ParaView®** is a trademark of **Kitware, Inc.**
|
|
309
|
+
- All other solver and product names are trademarks of their respective owners.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
sim/__init__.py,sha256=FQjdXr5BNBglRfKQ940zGQ3t5c2rCUjzDCuK2SYIp1Y,345
|
|
2
|
+
sim/__main__.py,sha256=hwGnM_V9it8Ds_SjAg0hRDqIaNp7L0A8Zx4WUbPKi6U,1034
|
|
3
|
+
sim/_plugin_install.py,sha256=_s5dAmKPdGaei9_Aqhvs1WbfyUg7eczi7m-Rb8OHMEA,17652
|
|
4
|
+
sim/_timeout.py,sha256=jUWw311yDinvqwWGO55CDgInbyioB3a4_8xovR_8g9E,3697
|
|
5
|
+
sim/cli.py,sha256=i5DzOrheTMre8ScOM82aoClAqg6CiQmoLqjBtubcVkA,55547
|
|
6
|
+
sim/compat.py,sha256=bclmoqJ3DoV49YoW5j6CQEA1e6yioGzcFgsMAP92ciM,15167
|
|
7
|
+
sim/config.py,sha256=Omm8WDOgk-cEynPsNEHqTPaONg9OChp4T4pjwcuBLgU,12298
|
|
8
|
+
sim/describe.py,sha256=VO-4nVES_Zidp9J4ZV3pjL9BVlKzHIog5USd0bXYc4I,14337
|
|
9
|
+
sim/driver.py,sha256=8jSmoeIeT9fh5XLaTDse8_d8w34xP-TggU5_-jkzrbE,6573
|
|
10
|
+
sim/history.py,sha256=y70gq8D1tL3po3a_2vhPq8icteeozBquR5vQeyeXFi8,5107
|
|
11
|
+
sim/inspect.py,sha256=8BI7KpVEkA6iDSHlpVz70ETeIg8xL-A2hvspqhT-9Rk,43039
|
|
12
|
+
sim/plugins.py,sha256=bzBgKKruMwzC2lWVoH49K-J0ksc6Nv7l4RAcTOW2vbA,17554
|
|
13
|
+
sim/runner.py,sha256=QGT9wAfN7mrO1n7BSn1x49c7kerSCXLscyJ2dCwZCOo,6641
|
|
14
|
+
sim/server.py,sha256=O7Zkojlbn-W8NavXitvuZmj4V4VqJg9NlReptQp17mw,18592
|
|
15
|
+
sim/session.py,sha256=XYA_MbAkgPT_-g3NHTyaYwgwvjhjo5QSEIWrtxK2G7o,8228
|
|
16
|
+
sim/drivers/__init__.py,sha256=Y_ZUbKW70mO08ts1Oul0zL9qEY0vxBgxC2WK5rkf2tA,6203
|
|
17
|
+
sim/drivers/coolprop/__init__.py,sha256=KQORHEBEGrsBY61NTV0E_-t-nL20GlcWSYY4iLHPTik,65
|
|
18
|
+
sim/drivers/coolprop/driver.py,sha256=Ar0irDwCZqovyCUvsG21y_MWcR3jEEogziJzUROSIg8,6306
|
|
19
|
+
sim/drivers/openfoam/__init__.py,sha256=mDaqEoon0RkAxxFBOA44hejB9W0Dj15F23NxHEtWIrY,152
|
|
20
|
+
sim/drivers/openfoam/compatibility.yaml,sha256=GUQY9DdLfIDZIXn3T6SIyk5G4IL48eyb3vO1FtKHm1k,1312
|
|
21
|
+
sim/drivers/openfoam/driver.py,sha256=v_CArZ-zeYncbVBrE_wd_WvxrzLrx8tpFAxX3L_Ngec,15486
|
|
22
|
+
sim/gui/__init__.py,sha256=464_Dy-Un-arkWkRFP1T2IR2sf1O4bMRiZYVgzE_dyg,8446
|
|
23
|
+
sim/gui/_pywinauto_tools.py,sha256=dsBPf1tTpc2LBcZDO9_szwfu_F8Vjel9sdVh0iGcdkc,16949
|
|
24
|
+
sim/gui/_win32_dialog.py,sha256=4hErvQxY4SwW_fTpX3FTUxhugkRYpkTRdBiBDu9_1DE,4731
|
|
25
|
+
sim/gui/LICENSES/ATTRIBUTION.md,sha256=X5EdZV0Gt0FdG9FpeCZ-22I3cqRg9SmoQt-86DqCBak,1150
|
|
26
|
+
sim/testing/__init__.py,sha256=iGwbSfJucKuhNLOiDnUmQCBlkhukWyp7cj89YDhoEOk,855
|
|
27
|
+
sim/testing/protocol_conformance.py,sha256=q0r7QgPoAyU-eMqN4fJWx0XZv8YNolGghu9-zDC8bls,9867
|
|
28
|
+
sim_cli_core-0.2.4.dist-info/METADATA,sha256=pJBJpEnzo96IFo22XB4O7Irfi5Uehzyd2r9TtNcGrxo,16465
|
|
29
|
+
sim_cli_core-0.2.4.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
|
|
30
|
+
sim_cli_core-0.2.4.dist-info/entry_points.txt,sha256=hpg7D0fRhpgmo1IyN35XQPoyIZRSw7SLNG7tW0eacGA,37
|
|
31
|
+
sim_cli_core-0.2.4.dist-info/licenses/LICENSE,sha256=7toF0XzHlqSXvTlZ8W77R6pg2ilzKN73EOG0SioX7wQ,10762
|
|
32
|
+
sim_cli_core-0.2.4.dist-info/licenses/NOTICE,sha256=IpKSNJwFq360Dy4be4dJ3wtNJ9BmjgcpxiYWUW4uoTs,3721
|
|
33
|
+
sim_cli_core-0.2.4.dist-info/RECORD,,
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding any notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright © 2026 Weiqi Ji
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
|
@@ -0,0 +1,72 @@
|
|
|
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
|
+
Third-party solver SDKs (runtime, optional — not bundled)
|
|
9
|
+
================================================================================
|
|
10
|
+
|
|
11
|
+
sim-cli integrates with commercial and open-source solvers by dynamically
|
|
12
|
+
importing their Python SDKs at runtime. No vendor SDK, solver binary, or vendor
|
|
13
|
+
example/tutorial material is redistributed as part of this repository. Users
|
|
14
|
+
install each SDK separately (via `sim env install`, optional extras in
|
|
15
|
+
pyproject.toml, or their own package manager) and are responsible for
|
|
16
|
+
complying with the license, copyright, and end-user agreement that ships
|
|
17
|
+
with each SDK and each underlying solver.
|
|
18
|
+
|
|
19
|
+
The drivers in `src/sim/drivers/` reference, but do not bundle, the following
|
|
20
|
+
third-party Python SDKs. This list is informational and may lag the code —
|
|
21
|
+
see `src/sim/drivers/<name>/compatibility.yaml` and `pyproject.toml` for the
|
|
22
|
+
current version pins.
|
|
23
|
+
|
|
24
|
+
Ansys / PyAnsys family (© ANSYS, Inc.)
|
|
25
|
+
- ansys-fluent-core https://github.com/ansys/pyfluent
|
|
26
|
+
- ansys-workbench-core https://github.com/ansys/pyworkbench
|
|
27
|
+
- ansys-mechanical-core https://github.com/ansys/pymechanical
|
|
28
|
+
- ansys-mapdl-core https://github.com/ansys/pymapdl
|
|
29
|
+
- ansys-dyna-core https://github.com/ansys/pydyna
|
|
30
|
+
- ansys-dpf-core https://github.com/ansys/pydpf-core
|
|
31
|
+
|
|
32
|
+
COMSOL (© COMSOL AB)
|
|
33
|
+
- mph https://github.com/MPh-py/MPh
|
|
34
|
+
(third-party Python wrapper around COMSOL's Java API; requires a COMSOL
|
|
35
|
+
Multiphysics license)
|
|
36
|
+
|
|
37
|
+
MathWorks (© The MathWorks, Inc.)
|
|
38
|
+
- matlabengine https://pypi.org/project/matlabengine/
|
|
39
|
+
(distributed by MathWorks; requires a MATLAB license)
|
|
40
|
+
|
|
41
|
+
Dassault Systèmes / Abaqus, Siemens STAR-CCM+ / Flotherm, BETA CAE ANSA,
|
|
42
|
+
Altair HyperMesh, Ansys ICEM CFD, Ansys CFX
|
|
43
|
+
- Driven via vendor CLIs / journal files / Python-in-solver interpreters.
|
|
44
|
+
No additional Python SDK is redistributed by sim-cli.
|
|
45
|
+
|
|
46
|
+
Open-source solvers and libraries
|
|
47
|
+
- PyBaMM, OpenFOAM, SU2, LAMMPS, CalculiX, Elmer FEM, Gmsh, meshio,
|
|
48
|
+
pyvista, PyMFEM, scikit-fem, SfePy, OpenSeesPy, Cantera, OpenMDAO,
|
|
49
|
+
FiPy, pymoo, Pyomo, SimPy, Trimesh, Devito, CoolProp, scikit-rf,
|
|
50
|
+
pandapower, ParaView (pvpython/pvbatch).
|
|
51
|
+
Each retains its own upstream license; consult the corresponding project
|
|
52
|
+
for terms.
|
|
53
|
+
|
|
54
|
+
================================================================================
|
|
55
|
+
Direct runtime dependencies (see pyproject.toml)
|
|
56
|
+
================================================================================
|
|
57
|
+
|
|
58
|
+
click, httpx, fastapi, uvicorn, pyyaml, Pillow, lxml
|
|
59
|
+
— each distributed under its own open-source license (BSD / MIT / Apache-2.0
|
|
60
|
+
family); consult the respective package for terms.
|
|
61
|
+
|
|
62
|
+
================================================================================
|
|
63
|
+
Trademarks
|
|
64
|
+
================================================================================
|
|
65
|
+
|
|
66
|
+
Product, solver, and company names referenced in this repository (including
|
|
67
|
+
Ansys®, Fluent®, Workbench®, Mechanical®, MAPDL, CFX®, LS-DYNA®, ICEM CFD™,
|
|
68
|
+
Abaqus®, SIMULIA®, COMSOL Multiphysics®, MATLAB®, Simcenter™ STAR-CCM+,
|
|
69
|
+
Simcenter Flotherm™, ANSA®, HyperMesh®, Altair®, ParaView®, OpenFOAM®) are
|
|
70
|
+
trademarks or registered trademarks of their respective owners and are used
|
|
71
|
+
solely for identification. sim-cli is an independent open-source project and
|
|
72
|
+
is not affiliated with, endorsed by, or sponsored by any of these vendors.
|