Skip to content

Simulation Tools

The simulation tools start simulations of a scenario and manage them. The results are analyzed with the analysis tools.

Examples:

  • "Simulate scenario 24 with three runs and tell me how many vehicles were teleported."
  • "Run scenario 24 with a time step of 0.5 seconds and write the trip information output."
  • "Rename simulation 5 to Baseline and export all its outputs as a ZIP."
Tool What it does
simulator__run_simulation Runs a simulation of a scenario with one or more runs and waits until it has finished.
workspace__list_simulations Lists your simulations. Can be limited to one scenario or to simulations whose name contains a text.
workspace__get_simulation Shows a simulation with its settings, its runs and the run statistics (vehicles, teleports, collisions...).
workspace__update_simulation Changes the name or the comment of a simulation.
workspace__export_simulation_zip Exports the outputs of all runs of a simulation as one ZIP archive and returns a download link.
workspace__remove_simulation Deletes a simulation and all of its runs.

Running simulations

simulator__run_simulation offers the settings of the Simulator: number of runs, time step length, lateral resolution, warm-up time, random seeds and which output files are written. Unset settings use the defaults of SESAM. The allowed time step lengths and lateral resolutions depend on the scenario and are part of its properties (workspace__get_scenario); SESAM rejects other values and names the allowed ones.

Which outputs are written decides what you can analyze: trips need the trip information output, which is optional. Ask the assistant to include it when you plan to look at individual trips.

Every run counts against your daily simulation quota. The assistant waits for the simulation and shows the progress, for example how many runs have finished. A simulation that is still running cannot be removed, and a running simulation cannot be stopped through MCP.

If the simulation takes longer than one hour, the assistant stops waiting. The simulation keeps running in SESAM and can be followed with workspace__get_simulation.

Following a simulation

workspace__get_simulation shows the status of the simulation and of each of its runs, together with the SUMO statistics of the finished runs. If one run fails, the simulation counts as failed and the log of the run helps to find the reason.

Exporting outputs

workspace__export_simulation_zip collects the output files of all runs in one ZIP archive. The export is created in the background and the assistant waits up to ten minutes for it. You receive a download link that you open in your browser.

Warning

The download link is not protected by a login. Anyone who has the link can download the archive, so do not share it.

Use the export when you need the raw data. For questions about the results, the analysis tools are more convenient.

Deleting simulations

workspace__remove_simulation deletes the simulation with all of its runs and their output files. The assistant has to confirm this explicitly when runs exist.