Start a parameter study
cm_study_startRun one test run several times with different parameter values in the background and return a study ID for waiting on results; no project files are modified.
Instructions
Run one test run several times with different parameter values, one after another, in the background. Returns a study id at once; wait with cm_study_wait. Nothing is written to project files. The answer names values that will change nothing: keys_not_found, workspace_not_found and workspace_overruled (the model has the variable in its own workspace: use scope=). IPGDriver corners only as fast as its limit Driver.Acc.ayMax allows (a test-run key): to compare variants on time, sweep it for each variant (keys {'Driver.Acc.ayMax': v}, steps of 0.5 around the current value) and compare each variant's fastest completed run.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | cm4sl: the MATLAB-connected session. standalone: a separate CarMaker process per run (no 'workspace' values) | cm4sl |
| scope | No | 'base' for the MATLAB base workspace, or the name of a loaded Simulink model for that model's workspace | base |
| testrun | Yes | Test run relative to Data/TestRun | |
| max_run_s | No | A run is stopped after this wall time in s | |
| save_logs | No | After every run, save what Simulink logged and the workspaces as that run used them to a MAT file next to its result file (mode cm4sl; logs_file per row) | |
| quantities | No | Quantities to summarise per run (default: Time, Car.v) | |
| variations | Yes | One entry per run: {'label': 'heavy', 'keys': {'Body.mass': 320}, 'workspace': {'Kp_yaw': 1.5}}. 'keys' are infofile keys applied in memory for that run only (prefix a place such as 'Vehicle:' if needed); 'workspace' are MATLAB variables in 'scope', restored after the run. Both are optional |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||