API Overview
The public API is centered on the eMachineSim Python wheel. After installation,
users import eMachineSim like a normal Python package.
The API is intentionally JSON-first:
- existing
input.jsonsamples remain valid - users can run a full analysis with one call
- advanced users can keep a
Sessionand update JSON sections between solves - CSV diagnostics remain the main stable result format
Main API Groups
| API | Purpose |
|---|---|
eMachineSim.run_file(path, run_directory=None) | Run an existing JSON input file. |
eMachineSim.run(input_json, run_directory) | Run from a Python dictionary. |
eMachineSim.version() | Return module and engine version information. |
eMachineSim.run_self_test(name) | Run built-in self-tests. |
eMachineSim.Session | Initialize once, update input sections, and call solve(). |
eMachineSim.get_* helpers | Read selected CSV outputs as Python dictionaries/lists. |
eMachineSim.thermal | Thermal convenience namespace. |
eMachineSim.structural | Structural convenience namespace. |
eMachineSim.modal | Modal/NVH convenience namespace. |
Public workflows should use the installed eMachineSim wheel; the internal
development executable is not the documented user interface.