eMachineSim Documentation
eMachineSim is a Python API based simulation toolset for electric machine design support. Its primary scope is thermal conduction, thermal equivalent circuit coupling, centrifugal-force structural analysis, and vibration/NVH for electric motors and related rotating electric machinery. It complements electromagnetic design workflows rather than replacing a dedicated electromagnetic field solver.
The current public scope is:
- steady heat conduction for motors and electric-machine components
- FEMH thermal equivalent circuit coupling
- BDF mesh and QVOL loss import
- JSON-defined coil copper loss and other volume heat sources
- stator/rotor gap and surface-to-surface thermal coupling diagnostics
- centrifugal-force structural analysis
- modal and vibration/NVH support workflows
- small electrostatic sample workflows for future electric-field extensions
This documentation is intended for engineers working on electric motors, generators, rotating electric machinery, and related electric-machine thermal and mechanical design tasks. It is not presented as a general-purpose FEM package for arbitrary civil, biomedical, or unrelated mechanical simulation domains.
Python API and SKILLS / MCP + Coding AI
The public interface is the eMachineSim Python wheel. Users run analyses from Python with JSON input control files and inspect generated CSV, VTK, and post-processing outputs.
Motor analysis setup often involves mesh regions, property IDs, loss sources, boundary conditions, thermal equivalent circuits, and diagnostic CSV files. For that reason, eMachineSim is designed to be used not only as a Python API, but also as an analysis workflow that coding AI can help operate through eMachineSim SKILLS and MCP server tools.
SKILLS provide workflow knowledge for coding AI. The MCP server provides structured access to Examples, input JSON files, and result CSV diagnostics. Together, they help a coding AI select the right example, prepare an input.json, run a Python script, inspect heat-balance CSV files, check surface assignment overlap, summarize gap/interface/cooling-path heat flows, and organize remaining engineering assumptions. This is intended to make motor thermal analysis, rotor structural checks, and modal/NVH sample evaluation easier to start and easier to audit.
Documentation Structure
| Section | Contents |
|---|---|
| Docs | supported analyses, installation, license setup, Quick Start, AI/SKILLS/MCP workflow, input.json, and output files |
| API | the Python API shape, Session workflow, result accessors, and recommended usage patterns |
| Showcase | runnable examples that explain real input files and expected diagnostic outputs |
Start Here
- Read Supported Analyses.
- Read Installation.
- Run the Quickstart.
- Read SKILLS / MCP + Coding AI.
- Inspect the input JSON guide.
- Try the realistic motor steady thermal showcase.