sim_run
Run mixed-signal simulations on the focused Altium project to generate a results document and retrieve per-analysis waveform summaries.
Instructions
Run Altium's mixed-signal simulation of the focused project.
Runs the analyses set up for the project: with sim_setup_analysis, or in Altium's Simulation Dashboard. A run started from a script performs an operating point, DC sweep, transient and AC together (MEASURED: the dashboard's on/off switches are not honoured).
It succeeds only when the run produced its results document (a .sdf, opened in its own tab), and fails with SIM_NOT_RUN when nothing appeared. The results are saved and read back: the reply carries each analysis's waves with min, max, first and last, and sim_get_results gives the traces.
Typical workflow: 1. Activate one of the project's schematic sheets. 2. Use sim_get_readiness + sim_attach_* to make sure every component has a SPICE model. 3. Place probes on measurement nodes with sch_place_probe. 4. Set the analyses with sim_setup_analysis. 5. Call sim_run, then sim_get_results for the traces.
Args: analysis: Free-form label echoed back in the response. Does not drive Altium, the project's setup does.
Returns: Dict with success, ran, results_document (the .sdf path), results_saved, results (per analysis, per wave: unit, points, min, max, first, last; magnitude for an AC wave), analysis and note.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| analysis | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||