sim-cli-core 0.4.2__tar.gz → 0.4.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/NOTICE +5 -0
  2. sim_cli_core-0.4.3/PKG-INFO +113 -0
  3. sim_cli_core-0.4.3/README.md +71 -0
  4. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/pyproject.toml +2 -2
  5. sim_cli_core-0.4.2/PKG-INFO +0 -163
  6. sim_cli_core-0.4.2/README.md +0 -121
  7. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/.gitignore +0 -0
  8. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/LICENSE +0 -0
  9. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/__init__.py +0 -0
  10. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/__main__.py +0 -0
  11. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_plugin_install.py +0 -0
  12. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_skills/external-solver-discovery/LICENSE +0 -0
  13. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_skills/external-solver-discovery/SKILL.md +0 -0
  14. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_skills/external-solver-discovery/provenance.json +0 -0
  15. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_skills/sim-cli/SKILL.md +0 -0
  16. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_skills/sim-cli/gui/SKILL.md +0 -0
  17. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_skills/sim-cli/gui/snippets/dismiss_named_dialog.py +0 -0
  18. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/_timeout.py +0 -0
  19. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/assets.py +0 -0
  20. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/cli.py +0 -0
  21. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/compat.py +0 -0
  22. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/config.py +0 -0
  23. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/describe.py +0 -0
  24. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/driver.py +0 -0
  25. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/drivers/__init__.py +0 -0
  26. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/gui/LICENSES/ATTRIBUTION.md +0 -0
  27. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/gui/__init__.py +0 -0
  28. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/gui/_pywinauto_tools.py +0 -0
  29. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/gui/_win32_dialog.py +0 -0
  30. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/history.py +0 -0
  31. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/inspect.py +0 -0
  32. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/plugins.py +0 -0
  33. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/runner.py +0 -0
  34. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/server.py +0 -0
  35. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/session.py +0 -0
  36. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/testing/__init__.py +0 -0
  37. {sim_cli_core-0.4.2 → sim_cli_core-0.4.3}/src/sim/testing/protocol_conformance.py +0 -0
@@ -25,6 +25,11 @@ Direct runtime dependencies (see pyproject.toml)
25
25
  - each distributed under its own open-source license (BSD / MIT /
26
26
  Apache-2.0 family); consult the respective package for terms.
27
27
 
28
+ simparse
29
+ - the parsing engine behind `sim scan`; distributed by SVD Lab as
30
+ prebuilt wheels under the simparse License (free to use, including
31
+ commercially). The license ships inside the simparse package.
32
+
28
33
  ================================================================================
29
34
  Trademarks
30
35
  ================================================================================
@@ -0,0 +1,113 @@
1
+ Metadata-Version: 2.5
2
+ Name: sim-cli-core
3
+ Version: 0.4.3
4
+ Summary: Agent-native simulation asset parsing and CAD/CAE runtime
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: SVD Lab
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ License-File: NOTICE
14
+ Keywords: agent,agentic,cad,cae,cae-files,cfd,fea,llm,parsing,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: psutil>=5.9; sys_platform == 'win32'
33
+ Requires-Dist: pywinauto>=0.6.8; sys_platform == 'win32'
34
+ Requires-Dist: pyyaml>=6.0
35
+ Requires-Dist: simparse<0.6,>=0.5.0
36
+ Requires-Dist: tomli>=2.0; python_version < '3.11'
37
+ Requires-Dist: uvicorn>=0.34
38
+ Provides-Extra: dev
39
+ Requires-Dist: pytest>=8.0; extra == 'dev'
40
+ Requires-Dist: ruff>=0.4; extra == 'dev'
41
+ Description-Content-Type: text/markdown
42
+
43
+ # sim
44
+
45
+ **`sim` reads existing CAE files and turns them into structured text an agent
46
+ can use — without launching the solver.**
47
+
48
+ ```bash
49
+ uv init # only if this is not already a uv project
50
+ uv add sim-cli-core
51
+ uv run sim --json scan ./historical-cases
52
+ ```
53
+
54
+ One call covers a whole folder. No solver, no license server, no vendor SDK.
55
+ The parsing engine scans roughly 4–20× faster than an equivalent Python script
56
+ ([benchmark](docs/simparse.md#speed)).
57
+ Output is bounded so a large scan fits in an agent's context, and absolute
58
+ paths are redacted by default.
59
+
60
+ ```console
61
+ $ uv run sim --json scan ./cases/beam.inp --full
62
+ {"schema_version": "sim.scan/v1",
63
+ "assets": [{"file_name": "beam.inp", "format": "abaqus-inp",
64
+ "summary": {"data": {"title": "Cantilever beam thermal-stress",
65
+ "node_count": 3, "element_count": 1, "materials": ["STEEL"],
66
+ "steps": ["STATIC"], "boundary_keywords": ["BOUNDARY"],
67
+ "load_keywords": ["CLOAD"], "output_keywords": ["NODE PRINT"]}}}]}
68
+ ```
69
+
70
+ (abridged — the full envelope also carries `ok`, `engine`, `request` and a
71
+ roll-up `summary`.)
72
+
73
+ ## Supported files
74
+
75
+ | Solver | Files | `--format` id |
76
+ | --- | --- | --- |
77
+ | COMSOL | `.mph` | `comsol-mph` |
78
+ | Abaqus | `.inp`, `.inc` | `abaqus-inp` |
79
+ | Fluent | `.cas.h5`, `.msh.h5` | `fluent-hdf5` |
80
+ | Ansys Electronics Desktop (HFSS / Icepak) | `.aedt`, `.aedtz` | `hfss-aedt` |
81
+ | Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
82
+ | Icepak Classic | `.tzr` | `icepak-tzr` |
83
+ | Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
84
+ | Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
85
+ | MATLAB data | `.mat` | `matlab-mat` |
86
+
87
+ What each format reports: [docs/simparse.md](docs/simparse.md).
88
+
89
+ ## Options
90
+
91
+ | Flag | Effect |
92
+ | --- | --- |
93
+ | `--full` | Complete parser result instead of the bounded summary (small input sets) |
94
+ | `--include-paths` | Keep absolute source paths |
95
+ | `--limit N`, `--no-recursive` | Bound a directory walk |
96
+ | `--format ID` | Force a format for an explicitly named file |
97
+
98
+ Every command takes `--json` and returns a stable envelope with a closed
99
+ error-code enum. `uv run sim --json describe` prints the full command manifest.
100
+
101
+ ## Docs
102
+
103
+ - [docs/agent-readability.md](docs/agent-readability.md) — JSON envelope,
104
+ error codes, exit codes. Read this first if you are an agent.
105
+ - [docs/simparse.md](docs/simparse.md) — what each file format reports.
106
+ - [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages
107
+ for detecting installs and driving a live solver session.
108
+ - [CONTRIBUTING.md](CONTRIBUTING.md) and [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md).
109
+
110
+ ## License
111
+
112
+ Apache-2.0 — see [LICENSE](LICENSE). Solvers are not bundled; vendor and
113
+ trademark notes are in [NOTICE](NOTICE).
@@ -0,0 +1,71 @@
1
+ # sim
2
+
3
+ **`sim` reads existing CAE files and turns them into structured text an agent
4
+ can use — without launching the solver.**
5
+
6
+ ```bash
7
+ uv init # only if this is not already a uv project
8
+ uv add sim-cli-core
9
+ uv run sim --json scan ./historical-cases
10
+ ```
11
+
12
+ One call covers a whole folder. No solver, no license server, no vendor SDK.
13
+ The parsing engine scans roughly 4–20× faster than an equivalent Python script
14
+ ([benchmark](docs/simparse.md#speed)).
15
+ Output is bounded so a large scan fits in an agent's context, and absolute
16
+ paths are redacted by default.
17
+
18
+ ```console
19
+ $ uv run sim --json scan ./cases/beam.inp --full
20
+ {"schema_version": "sim.scan/v1",
21
+ "assets": [{"file_name": "beam.inp", "format": "abaqus-inp",
22
+ "summary": {"data": {"title": "Cantilever beam thermal-stress",
23
+ "node_count": 3, "element_count": 1, "materials": ["STEEL"],
24
+ "steps": ["STATIC"], "boundary_keywords": ["BOUNDARY"],
25
+ "load_keywords": ["CLOAD"], "output_keywords": ["NODE PRINT"]}}}]}
26
+ ```
27
+
28
+ (abridged — the full envelope also carries `ok`, `engine`, `request` and a
29
+ roll-up `summary`.)
30
+
31
+ ## Supported files
32
+
33
+ | Solver | Files | `--format` id |
34
+ | --- | --- | --- |
35
+ | COMSOL | `.mph` | `comsol-mph` |
36
+ | Abaqus | `.inp`, `.inc` | `abaqus-inp` |
37
+ | Fluent | `.cas.h5`, `.msh.h5` | `fluent-hdf5` |
38
+ | Ansys Electronics Desktop (HFSS / Icepak) | `.aedt`, `.aedtz` | `hfss-aedt` |
39
+ | Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
40
+ | Icepak Classic | `.tzr` | `icepak-tzr` |
41
+ | Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
42
+ | Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
43
+ | MATLAB data | `.mat` | `matlab-mat` |
44
+
45
+ What each format reports: [docs/simparse.md](docs/simparse.md).
46
+
47
+ ## Options
48
+
49
+ | Flag | Effect |
50
+ | --- | --- |
51
+ | `--full` | Complete parser result instead of the bounded summary (small input sets) |
52
+ | `--include-paths` | Keep absolute source paths |
53
+ | `--limit N`, `--no-recursive` | Bound a directory walk |
54
+ | `--format ID` | Force a format for an explicitly named file |
55
+
56
+ Every command takes `--json` and returns a stable envelope with a closed
57
+ error-code enum. `uv run sim --json describe` prints the full command manifest.
58
+
59
+ ## Docs
60
+
61
+ - [docs/agent-readability.md](docs/agent-readability.md) — JSON envelope,
62
+ error codes, exit codes. Read this first if you are an agent.
63
+ - [docs/simparse.md](docs/simparse.md) — what each file format reports.
64
+ - [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages
65
+ for detecting installs and driving a live solver session.
66
+ - [CONTRIBUTING.md](CONTRIBUTING.md) and [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md).
67
+
68
+ ## License
69
+
70
+ Apache-2.0 — see [LICENSE](LICENSE). Solvers are not bundled; vendor and
71
+ trademark notes are in [NOTICE](NOTICE).
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "sim-cli-core"
3
- version = "0.4.2"
3
+ version = "0.4.3"
4
4
  description = "Agent-native simulation asset parsing and CAD/CAE runtime"
5
5
  readme = "README.md"
6
6
  license = "Apache-2.0"
@@ -30,7 +30,7 @@ classifiers = [
30
30
  # corresponding plugin's install, or directly by the user. compat.yaml
31
31
  # documents which combinations are supported.
32
32
  dependencies = [
33
- "simparse>=0.4,<0.5",
33
+ "simparse>=0.5.0,<0.6",
34
34
  "click>=8.0",
35
35
  "httpx>=0.28",
36
36
  "fastapi>=0.115",
@@ -1,163 +0,0 @@
1
- Metadata-Version: 2.5
2
- Name: sim-cli-core
3
- Version: 0.4.2
4
- Summary: Agent-native simulation asset parsing and CAD/CAE runtime
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: SVD Lab
11
- License-Expression: Apache-2.0
12
- License-File: LICENSE
13
- License-File: NOTICE
14
- Keywords: agent,agentic,cad,cae,cae-files,cfd,fea,llm,parsing,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: psutil>=5.9; sys_platform == 'win32'
33
- Requires-Dist: pywinauto>=0.6.8; sys_platform == 'win32'
34
- Requires-Dist: pyyaml>=6.0
35
- Requires-Dist: simparse<0.5,>=0.4
36
- Requires-Dist: tomli>=2.0; python_version < '3.11'
37
- Requires-Dist: uvicorn>=0.34
38
- Provides-Extra: dev
39
- Requires-Dist: pytest>=8.0; extra == 'dev'
40
- Requires-Dist: ruff>=0.4; extra == 'dev'
41
- Description-Content-Type: text/markdown
42
-
43
- # sim
44
-
45
- **`sim` reads existing CAE files and turns them into structured text an agent
46
- can use — without launching the solver.**
47
-
48
- Python 3.10+ · Apache-2.0 · alpha
49
-
50
- ---
51
-
52
- ## Scan existing simulation assets
53
-
54
- Point `sim scan` at a folder of `.mph` / `.inp` / `.cas.h5` / `.aedt` files and
55
- get back structured JSON an agent can reason over — model inventory, materials,
56
- boundary conditions, mesh counts, solve settings. No solver, no license, and
57
- nothing else to install:
58
-
59
- ```bash
60
- uv init # only if this is not already a uv project
61
- uv add sim-cli-core
62
- uv run sim --json scan ./historical-cases
63
- ```
64
-
65
- ```console
66
- $ uv run sim --json scan ./cases/beam.inp --full
67
- {
68
- "schema_version": "sim.scan/v1",
69
- "assets": [{
70
- "file_name": "beam.inp",
71
- "format": "abaqus-inp",
72
- "summary": {"data": {
73
- "title": "Cantilever beam thermal-stress",
74
- "node_count": 3,
75
- "element_count": 1,
76
- "materials": ["STEEL"],
77
- "sections": ["SOLID SECTION:STEEL"],
78
- "steps": ["STATIC"],
79
- "boundary_keywords": ["BOUNDARY"],
80
- "load_keywords": ["CLOAD"],
81
- "output_keywords": ["NODE PRINT"]
82
- }}
83
- }]
84
- }
85
- ```
86
-
87
- (abridged — the real envelope also carries `ok`, `engine`, `request`, and a
88
- roll-up `summary` block.)
89
-
90
- | Solver | Files | `--format` id |
91
- | --- | --- | --- |
92
- | COMSOL | `.mph` | `comsol-mph` |
93
- | Abaqus | `.inp`, `.inc` | `abaqus-inp` |
94
- | Fluent | `.cas.h5`, `.msh.h5` | `fluent-hdf5` |
95
- | Ansys Electronics Desktop (HFSS / Icepak) | `.aedt`, `.aedtz` | `hfss-aedt` |
96
- | Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
97
- | Icepak Classic | `.tzr` | `icepak-tzr` |
98
- | Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
99
- | Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
100
- | MATLAB data | `.mat` | `matlab-mat` |
101
-
102
- The default view is bounded — lists come back as `{total, sample, truncated}`
103
- so a large scan cannot blow up an agent's context — and absolute paths are
104
- redacted unless `--include-paths` is set. Use `--full` for the complete parser
105
- result on a small input set, `--limit` and `--no-recursive` to bound a directory
106
- walk, and `--format` to force a format for an explicitly named file. What each
107
- format reports: [docs/simparse.md](docs/simparse.md).
108
-
109
- Every command takes `--json` and returns a stable envelope with a closed
110
- error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
111
- Run `uv run sim --json describe` for a machine-readable command manifest.
112
-
113
- ## Example: what's in this folder?
114
-
115
- ```text
116
- Scan ./legacy-cases and tell me which models are package-level thermal
117
- studies, which already have solved results, and what total power each one
118
- assumes. Use `uv run sim --json scan`.
119
- ```
120
-
121
- ## Optional: working with a local solver
122
-
123
- Scanning never needs a solver. If an agent also has to detect solver installs,
124
- lint a script before running it, or keep a solver session open, add that
125
- solver's package (for example `sim-plugin-comsol`) and its agent skill:
126
-
127
- ```bash
128
- uv add sim-plugin-comsol
129
- uv run sim plugin sync-skills --target .agents/skills --copy # .claude/skills for Claude Code
130
- uv run sim check comsol
131
- ```
132
-
133
- The supported solvers, install commands, live-session commands, and the
134
- `sim.toml` manifest are covered in
135
- [docs/plugin-install.md](docs/plugin-install.md). Running the solver on another
136
- host is covered in [docs/remote-solvers.md](docs/remote-solvers.md).
137
-
138
- ## Solver ownership
139
-
140
- `sim-cli` does not bundle or redistribute simulation solvers or vendor SDKs.
141
- Install and operate each underlying solver according to its vendor terms. See
142
- [NOTICE](NOTICE) for optional SDK dependency notes.
143
-
144
- `sim-cli` is an independent open-source project and is not affiliated with,
145
- endorsed by, or sponsored by any solver vendor. Product, solver, and company
146
- names remain the property of their respective owners.
147
-
148
- ## Docs
149
-
150
- - [docs/agent-readability.md](docs/agent-readability.md) — `--json` envelope,
151
- error-code enum, exit codes. Read this first if you are an agent.
152
- - [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages,
153
- live sessions, and the `sim.toml` reference
154
- - [docs/remote-solvers.md](docs/remote-solvers.md) — running the solver on
155
- another host, and the security constraints that apply
156
- - [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) — project setup, layout, driver
157
- protocol, and architecture notes
158
- - [docs/why-cli-first.md](docs/why-cli-first.md) — why a CLI rather than MCP
159
- - [CONTRIBUTING.md](CONTRIBUTING.md) — branch, test, and PR workflow
160
-
161
- ## License
162
-
163
- Apache-2.0 — see [LICENSE](LICENSE).
@@ -1,121 +0,0 @@
1
- # sim
2
-
3
- **`sim` reads existing CAE files and turns them into structured text an agent
4
- can use — without launching the solver.**
5
-
6
- Python 3.10+ · Apache-2.0 · alpha
7
-
8
- ---
9
-
10
- ## Scan existing simulation assets
11
-
12
- Point `sim scan` at a folder of `.mph` / `.inp` / `.cas.h5` / `.aedt` files and
13
- get back structured JSON an agent can reason over — model inventory, materials,
14
- boundary conditions, mesh counts, solve settings. No solver, no license, and
15
- nothing else to install:
16
-
17
- ```bash
18
- uv init # only if this is not already a uv project
19
- uv add sim-cli-core
20
- uv run sim --json scan ./historical-cases
21
- ```
22
-
23
- ```console
24
- $ uv run sim --json scan ./cases/beam.inp --full
25
- {
26
- "schema_version": "sim.scan/v1",
27
- "assets": [{
28
- "file_name": "beam.inp",
29
- "format": "abaqus-inp",
30
- "summary": {"data": {
31
- "title": "Cantilever beam thermal-stress",
32
- "node_count": 3,
33
- "element_count": 1,
34
- "materials": ["STEEL"],
35
- "sections": ["SOLID SECTION:STEEL"],
36
- "steps": ["STATIC"],
37
- "boundary_keywords": ["BOUNDARY"],
38
- "load_keywords": ["CLOAD"],
39
- "output_keywords": ["NODE PRINT"]
40
- }}
41
- }]
42
- }
43
- ```
44
-
45
- (abridged — the real envelope also carries `ok`, `engine`, `request`, and a
46
- roll-up `summary` block.)
47
-
48
- | Solver | Files | `--format` id |
49
- | --- | --- | --- |
50
- | COMSOL | `.mph` | `comsol-mph` |
51
- | Abaqus | `.inp`, `.inc` | `abaqus-inp` |
52
- | Fluent | `.cas.h5`, `.msh.h5` | `fluent-hdf5` |
53
- | Ansys Electronics Desktop (HFSS / Icepak) | `.aedt`, `.aedtz` | `hfss-aedt` |
54
- | Ansys Mechanical | `.mechdb`, `.mechdat` | `ansys-mechanical` |
55
- | Icepak Classic | `.tzr` | `icepak-tzr` |
56
- | Simcenter FloTHERM | `.pack`, `.xml`, `.floxml` | `flotherm-pack`, `flotherm-floxml` |
57
- | Simulink | `.slx`, `.mdl` | `simulink-slx`, `simulink-mdl` |
58
- | MATLAB data | `.mat` | `matlab-mat` |
59
-
60
- The default view is bounded — lists come back as `{total, sample, truncated}`
61
- so a large scan cannot blow up an agent's context — and absolute paths are
62
- redacted unless `--include-paths` is set. Use `--full` for the complete parser
63
- result on a small input set, `--limit` and `--no-recursive` to bound a directory
64
- walk, and `--format` to force a format for an explicitly named file. What each
65
- format reports: [docs/simparse.md](docs/simparse.md).
66
-
67
- Every command takes `--json` and returns a stable envelope with a closed
68
- error-code enum — see [docs/agent-readability.md](docs/agent-readability.md).
69
- Run `uv run sim --json describe` for a machine-readable command manifest.
70
-
71
- ## Example: what's in this folder?
72
-
73
- ```text
74
- Scan ./legacy-cases and tell me which models are package-level thermal
75
- studies, which already have solved results, and what total power each one
76
- assumes. Use `uv run sim --json scan`.
77
- ```
78
-
79
- ## Optional: working with a local solver
80
-
81
- Scanning never needs a solver. If an agent also has to detect solver installs,
82
- lint a script before running it, or keep a solver session open, add that
83
- solver's package (for example `sim-plugin-comsol`) and its agent skill:
84
-
85
- ```bash
86
- uv add sim-plugin-comsol
87
- uv run sim plugin sync-skills --target .agents/skills --copy # .claude/skills for Claude Code
88
- uv run sim check comsol
89
- ```
90
-
91
- The supported solvers, install commands, live-session commands, and the
92
- `sim.toml` manifest are covered in
93
- [docs/plugin-install.md](docs/plugin-install.md). Running the solver on another
94
- host is covered in [docs/remote-solvers.md](docs/remote-solvers.md).
95
-
96
- ## Solver ownership
97
-
98
- `sim-cli` does not bundle or redistribute simulation solvers or vendor SDKs.
99
- Install and operate each underlying solver according to its vendor terms. See
100
- [NOTICE](NOTICE) for optional SDK dependency notes.
101
-
102
- `sim-cli` is an independent open-source project and is not affiliated with,
103
- endorsed by, or sponsored by any solver vendor. Product, solver, and company
104
- names remain the property of their respective owners.
105
-
106
- ## Docs
107
-
108
- - [docs/agent-readability.md](docs/agent-readability.md) — `--json` envelope,
109
- error-code enum, exit codes. Read this first if you are an agent.
110
- - [docs/plugin-install.md](docs/plugin-install.md) — optional solver packages,
111
- live sessions, and the `sim.toml` reference
112
- - [docs/remote-solvers.md](docs/remote-solvers.md) — running the solver on
113
- another host, and the security constraints that apply
114
- - [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) — project setup, layout, driver
115
- protocol, and architecture notes
116
- - [docs/why-cli-first.md](docs/why-cli-first.md) — why a CLI rather than MCP
117
- - [CONTRIBUTING.md](CONTRIBUTING.md) — branch, test, and PR workflow
118
-
119
- ## License
120
-
121
- Apache-2.0 — see [LICENSE](LICENSE).
File without changes
File without changes