Skip to content

Workspace Tools

The workspace tools manage your projects and scenarios. Simulations have their own page: Simulations.

Examples:

  • "List my scenarios and rename the one called Test to Berlin Mitte morning peak."
  • "Duplicate scenario 24 and move the copy into my project Study 2030."
  • "Which traffic lights does scenario 24 have, and how long is their cycle?"

Projects

Tool What it does
workspace__list_projects Lists your projects.
workspace__create_project Creates a project with a name and an optional comment.
workspace__remove_project Deletes a project and all scenarios in it.

Scenarios

Tool What it does
workspace__list_scenarios Lists your scenarios. Can be limited to scenarios whose name contains a text or to one project.
workspace__get_scenario Shows the details of a scenario: size, coordinate system, traffic demand, vehicle types and log.
workspace__get_traffic_lights Shows the traffic lights of a scenario with their junctions and signal plans (optionally the phases).
workspace__update_scenario Changes the name or the comment of a scenario, moves it into a project or takes it out of a project.
workspace__duplicate_scenario Creates a copy of a scenario, without its simulations.
workspace__export_scenario_zip Exports a scenario as a ZIP archive and returns a download link.
workspace__upload_scenario Creates a scenario from a SUMO scenario ZIP archive that is available at a public https link.
workspace__remove_scenario Deletes a scenario and all simulations based on it.

Changing comments

workspace__update_scenario replaces the comment of a scenario. To add a sentence to an existing comment, the assistant first reads the current comment and then writes the combined text.

Traffic lights

workspace__get_traffic_lights lists the traffic-light controllers of a scenario, the junctions each of them controls (a joined traffic light controls several) and its signal plans with type, cycle time and offset. Ask for the phases to also see the duration and the signal states of every phase. It describes the current state of the scenario and is available with every plan.

ZIP export

The export is created in the background and the assistant waits up to two 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.

Uploading scenarios

workspace__upload_scenario does not transfer files from your computer. SESAM downloads the ZIP archive from a public https link that you provide, for example from a file hosting service. Links to private or internal addresses, links with a username and password, and files larger than your plan allows are rejected.

Optional settings are the scenario name and comment, the project, the begin time and duration, and whether the floating car data (FCD) output is disabled. For the simulation options the following values are allowed:

Option Allowed values (in seconds / meters)
Time step length 0.1, 0.5, 1 (default: 0.5 and 1)
Lateral resolution -1, 0.1, 0.4, 0.8, 1.6 (default: -1 and 1.6)

A lateral resolution of -1 switches the sublane model off. See the Simulator for the meaning of these options.

Every upload attempt counts against your daily upload quota. The tool therefore checks your plan and the file size before it starts.