Scroll to navigation

ECLIPSE(1) User Commands ECLIPSE(1)

NAME

Eclipse - A microscopic, multi-modal traffic simulation

SYNOPSIS

sumo [OPTION]*

DESCRIPTION

Eclipse SUMO sumo Version 1.15.0

Copyright (C) 2001-2022 German Aerospace Center (DLR) and others; https://sumo.dlr.de

A microscopic, multi-modal traffic simulation.

Configuration Options:

Loads the named config on startup
Saves current configuration into FILE
Enforce relative paths when saving the configuration
Saves a configuration template (empty) into FILE
Saves the configuration schema into FILE
Adds comments to saved template, configuration, or schema

Input Options:

Load road network description from FILE
Load routes descriptions from FILE(s)
Load further descriptions from FILE(s)
Load edge/lane weights for online rerouting from FILE
Name of the xml attribute which gives the edge weight
Loads a network state from FILE
Shifts all times loaded from a saved state by the given offset
Removes vehicles with the given IDs from the loaded state
Initialize a TAZ for every junction to use attributes toJunction and fromJunction

Output Options:

Include license info into every output file
Prefix which is applied to all output files. The special string 'TIME' is replaced by the current time.
Defines the number of digits after the comma for floating point output
Defines the number of digits after the comma for lon,lat output
Write time values as hour:minute:second or day:hour:minute:second rather than seconds
Save complete network states into FILE
Write also empty edges completely when dumping
Write positions and speeds with the given precision (default 2)
Save the emission values of each vehicle
Write emission values with the given precision (default 2)
Save the positions in emission output using geo-coordinates (lon/lat)
Write emission values scaled to the step length rather than as per-second values
Save the battery values of each vehicle
Write battery values with the given precision (default 2)
Save the elecHybrid values of each vehicle
Write elecHybrid values with the given precision (default 2)
Write elecHybrid values into one aggregated file
Write data of charging stations
Write data of overhead wire segments
Write data of electrical substation stations
Write substation values with the given precision (default 2)
Save the Floating Car Data
Save the Floating Car Data using geo-coordinates (lon/lat)
Add the vehicle signal state to the FCD output (brake lights etc.)
Add kilometrage to the FCD output (linear referencing)
Add acceleration to the FCD output
Add leader vehicle information to the FCD output (within the given distance)
Add generic parameter values to the FCD output
Restrict fcd output to the edge selection from the given input file
List attributes that should be included in the FCD output
List shape names that should be used to filter the FCD output
Restrict SSM device output to the edge selection from the given input file
Save a lot of information for each timestep (very redundant)
Save the vehicle queues at the junctions (experimental)
Save vehicle queues with the given period
Save complete vehicle positions inclusive speed values in the VTK Format (usage: /path/out will produce /path/out_$TIMESTEP$.vtp files)
Save the vehicle trajectories in the Amitran format
Save aggregated vehicle departure info into FILE
Save summary-output with the given period
Save aggregated person counts into FILE
Save single vehicle trip info into FILE
Write tripinfo output for vehicles which have not arrived at simulation end
Write tripinfo output for vehicles which have not departed at simulation end because of depart delay
Save single vehicle route info into FILE
Write the exit times for all edges
Write the last route only
Sorts the output by departure time
Write the output in the duarouter alternatives style
Write costs for all routes
Write the output with the intended instead of the real departure time
Include total route length in the output
Write vehroute output for vehicles which have not arrived at simulation end
Skip vehroute output for public transport vehicles
Include invalid routes and route stubs in vehroute output
Include information about edges between stops
Write the vehicle speedFactor (defaults to 'true' if departSpeed is written)
Include internal edges in the output
Save person and container routes to separate FILE
Save links states into FILE
Save railsignal-blocks into FILE
Save bluetooth visibilities into FILE (in conjunction with device.btreceiver and device.btsender)
Record lane changes and their motivations for all vehicles into FILE
Record start of lane change manoeuvres
Record end of lane change manoeuvres
Record coordinates of lane change manoeuvres
Record stops and loading/unloading of passenger and containers for all vehicles into FILE
Write stop output for stops which have not ended at simulation end
Write collision information into FILE
Write aggregated traffic statistics for all edges into FILE
Write aggregated traffic statistics for all lanes into FILE
Write overall statistics into FILE
Use TIME[] as times at which a network state written
save state repeatedly after TIME period
Keep only the last INT periodic state files
Prefix for network states
Suffix for network states (.xml.gz or .xml)
Files for network states
Save random number generator states
Save person and container states (experimental)
Save rail signal constraints
Write internal state values with the given precision (default 2)

Time Options:

Defines the begin time in seconds; The simulation starts at this time
Defines the end time in seconds; The simulation ends at this time
Defines the step duration in seconds

Processing Options:

Whether to use ballistic method for the positional update of vehicles (default is a semi-implicit Euler method).
Whether vehicles that depart between simulation steps should extrapolate the depart position
Defines the number of threads for parallel simulation
Defines the resolution in m when handling lateral positioning within a lane (with -1 all vehicles drive at the center of their lane
Load routes for the next number of seconds ahead
Disable (junction) internal links
Ignore vehicles which block the junction after they have been standing for SECONDS (-1 means never ignore)
Do not check whether routes are connected
Do not check whether accidents occur
How to deal with collisions: [none,warn,teleport,remove]
Let vehicle stop for TIME before performing collision.action (except for action 'none')
Enables collisions checks on junctions
Increase or decrease sensitivity for junction collision check
Sets the fraction of minGap that must be maintained to avoid collision detection. If a negative value is given, the carFollowModel parameter is used
Delay vehicle insertion to stay within the given maximum number
Abort the simulation if the given maximum number of teleports is exceeded
Scale demand by the given factor (by discarding or duplicating vehicles)
Suffix to be added when creating ids for cloned vehicles
Specify how long a vehicle may wait until being teleported, defaults to 300, non-positive values disable teleporting
The waiting time after which vehicles on a fast road (speed > 69km/h) are teleported if they are on a non-continuing lane
The waiting time after which vehicles on a fast road (default: speed > 69km/h) are teleported if they are on a non-continuing lane
The waiting time after which vehicles with a disconnected route are teleported. Negative values disable teleporting
Whether vehicles shall be removed after waiting too long instead of being teleported
The waiting time after which persons / containers waiting for a pickup are teleported. Negative values disable teleporting
The waiting time after which vehicles on bidirectional edges are teleported
Length of time interval, over which accumulated waiting time is taken into account (default is 100s.)
Minimum consecutive waiting time before applying startupDelay
How long vehicles wait for departure before being skipped, defaults to -1 which means vehicles are never skipped
Whether insertion on an edge shall not be repeated in same step once failed
Whether each vehicle is checked separately for insertion on an edge
Allow inserting a vehicle in a situation which requires emergency braking
Each vehicle receives a random offset to its depart value drawn uniformly from [0, TIME]
Duration of a lane change maneuver (default 0)
Whether overtaking on the right on motorways is permitted
Switches off all traffic lights.
Sets default visibility for actuation detectors
Sets default jam-treshold parameter for all actuation detectors
Sets default detector length parameter for all actuation detectors
Sets default range for detecting delayed vehicles
Minimum deceleration when braking at yellow
Let railsignals operate in moving-block mode by default
Specify how long a vehicle may wait until impatience grows from 0 to 1, defaults to 300, non-positive values disable impatience growth
Length of the default interval length between action points for the car-following and lane-change models (in seconds). If not specified, the simulation step-length is used per default. Vehicle- or VType-specific settings override the default. Must be a multiple of the simulation step-length.
Select default car following model (Krauss, IDM, ...)
Select default speed deviation. A negative value implies vClass specific defaults (0.1 for the default passenger class
Select default emergencyDecel value among ('decel', 'default', FLOAT) which sets the value either to the same as the deceleration value, a vClass-class specific default or the given FLOAT in m/s^2
Use Kirchhoff's laws for solving overhead wire circuit
Enable recuperation from the vehicle equipped with elecHybrid device into the ovrehead wire.
Enable current limits of traction substation during solving the overhead wire electrical circuit.
Sets the fraction of emergency decel capability that must be used to trigger a warning.
Whether parking simulation includes manoeuvering time and associated lane blocking
Override stop until times with stop ended times when given
Select among pedestrian models ['nonInteracting', 'striping', 'remote']
Width of parallel stripes for segmenting a sidewalk (meters) for use with model 'striping'
Factor for random slow-downs [0,1] for use with model 'striping'
Minimal gap / safety buffer (in meters) from a pedestrian to another vehicle for use with model 'striping'
Time in seconds after which pedestrians start squeezing through a jam when using model 'striping' (non-positive values disable squeezing)
Time in seconds after which pedestrians start squeezing through a jam while on a pedestrian crossing when using model 'striping' (non-positive values disable squeezing)
Time in seconds after which pedestrians start squeezing through a jam while on a narrow lane when using model 'striping'
Fraction of stripes to reserve for oncoming pedestrians
Fraction of stripes to reserve for oncoming pedestrians on crossings and walkingareas
Interpret departPosLat for walks in legacy style
Generate INT intermediate points to smooth out lanes within the walkingarea
The address (host:port) of the external simulation
Tolerance to apply when matching pedestrian and vehicle positions on boarding at individual stops
Use FLOAT as a factor on walking speed against vehicle traffic direction

Routing Options:

Select among routing algorithms ['dijkstra', 'astar', 'CH', 'CHWrapper']
Edge weights for routing are dynamically disturbed by a random factor drawn uniformly from [1,FLOAT)
Apply the given time penalty when computing minimum routing costs for minor-link internal lanes
Apply scaled travel time penalties based on green split when computing minimum routing costs for internal lanes at traffic lights
Consider edge priorities in addition to travel times, weighted by factor
Distinguish travel time by turn direction and shift a fraction of the estimated time loss ahead of the intersection onto the internal edges
Initialize lookup table for astar from the given file (generated by marouter --all-pairs-output)
Initialize lookup table for astar ALT-variant from the given file
Use FLOAT as a factor on pedestrian maximum speed during intermodal routing
Where are mode changes from car to walking allowed (possible values: 'parkingAreas', 'ptStops', 'allJunctions' and combinations)
Where taxis can drop off customers ('allJunctions, 'ptStops')
Where taxis can pick up customers ('allJunctions, 'ptStops')
When set, trips between the same origin and destination will share a taxi by default
Estimated time for taxi pickup
Use FLOAT as a maximum train length when initializing the railway router
Replay exact rerouting sequence from vehroute-output
The probability for a vehicle to have a 'rerouting' device
Assign a 'rerouting' device to named vehicles
The 'rerouting' devices are set deterministic using a fraction of 1000
The period with which the vehicle shall be rerouted
The rerouting period before depart
The weight of prior edge weights for exponential moving average
The number of steps for moving average weight of prior edge weights
The interval for updating the edge weights
Use zones (districts) as routing startand endpoints
Use weight files given with option --weight-files for initializing edge weights
The number of parallel execution threads used for rerouting
Let rerouting happen at the same time for all vehicles
Allow rerouting triggered by rail signals.
Compute separate average speeds for bicycles
Save adapting weights to FILE
The probability for a person to have a 'rerouting' device
Assign a 'rerouting' device to named persons
The 'rerouting' devices are set deterministic using a fraction of 1000
The period with which the person shall be rerouted

Report Options:

Switches to verbose output
Prints option values before processing
-?, --help
Prints this screen or selected topics
Prints the current version
Set schema validation scheme of XML inputs ("never", "local", "auto" or "always")
Set schema validation scheme of SUMO network inputs ("never", "local", "auto" or "always")
Set schema validation scheme of SUMO route inputs ("never", "local", "auto" or "always")
Disables output of warnings
Aggregate warnings of the same type whenever more than INT occur
Writes all messages to FILE (implies verbose)
Writes all non-error messages to FILE (implies verbose)
Writes all warnings and errors to FILE
Disable performance reports for individual simulation steps
Enable statistics on vehicle trips
Disable console output of current simulation step
Number of simulation steps between step-log outputs

Emissions Options:

Return fuel consumption values in (legacy) unit l instead of mg
Determines where to load PHEMlight definitions from
Enable fleet age modelling with the given reference year in PHEMlight5
Set ambient temperature to correct NOx emissions in PHEMlight5
The probability for a vehicle to have a 'emissions' device
Assign a 'emissions' device to named vehicles
The 'emissions' devices are set deterministic using a fraction of 1000
Recording begin time for emission-data
Recording period for emission-output

Communication Options:

The probability for a vehicle to have a 'btreceiver' device
Assign a 'btreceiver' device to named vehicles
The 'btreceiver' devices are set deterministic using a fraction of 1000
The range of the bt receiver
Whether all recognition point shall be written
The offtime used for calculating detection probability (in seconds)
The probability for a vehicle to have a 'btsender' device
Assign a 'btsender' device to named vehicles
The 'btsender' devices are set deterministic using a fraction of 1000
The probability for a person to have a 'btsender' device
Assign a 'btsender' device to named persons
The 'btsender' devices are set deterministic using a fraction of 1000
The probability for a person to have a 'btreceiver' device
Assign a 'btreceiver' device to named persons
The 'btreceiver' devices are set deterministic using a fraction of 1000

Battery Options:

The probability for a vehicle to have a 'battery' device
Assign a 'battery' device to named vehicles
The 'battery' devices are set deterministic using a fraction of 1000
Track fuel consumption for non-electric vehicles

Example Device Options:

The probability for a vehicle to have a 'example' device
Assign a 'example' device to named vehicles
The 'example' devices are set deterministic using a fraction of 1000
An exemplary parameter which can be used by all instances of the example device

SSM Device Options:

The probability for a vehicle to have a 'ssm' device
Assign a 'ssm' device to named vehicles
The 'ssm' devices are set deterministic using a fraction of 1000
Specifies which measures will be logged (as a space or comma-separated sequence of IDs in ('TTC', 'DRAC', 'PET'))
Specifies space or comma-separated thresholds corresponding to the specified measures (see documentation and watch the order!). Only events exceeding the thresholds will be logged.
Specifies whether trajectories will be logged (if false, only the extremal values and times are reported).
Specifies the detection range in meters. For vehicles below this distance from the equipped vehicle, SSM values are traced.
Specifies the time in seconds to be logged after a conflict is over. Required >0 if PET is to be calculated for crossing conflicts.
Give a global default filename for the SSM output
Whether to use coordinates of the original reference system in output
Whether to write positions (coordinates) for each timestep
Whether to write lanes and their positions for each timestep

ToC Device Options:

The probability for a vehicle to have a 'toc' device
Assign a 'toc' device to named vehicles
The 'toc' devices are set deterministic using a fraction of 1000
Vehicle type for manual driving regime.
Vehicle type for automated driving regime.
Average response time needed by a driver to take back control.
Recovery rate for the driver's awareness after a ToC.
Attention level below which a driver restrains from performing lane changes (value in [0,1]).
Average awareness a driver has initially after a ToC (value in [0,1]).
Deceleration rate applied during a 'minimum risk maneuver'.
Time, which the vehicle requires to have ahead to continue in automated mode. The default value of 0 indicates no dynamic triggering of ToCs.
Probability that a dynamically triggered TOR is not answered in time.
If true, the vehicle tries to change to the right during an MRM.
If set, the vehicle tries to reach the given named stopping place during an MRM.
Duration the vehicle stays at the safe spot after an MRM.
Maximal acceleration that may be applied during the ToC preparation phase.
Timegap for ToC preparation phase.
Additional spacing for ToC preparation phase.
Maximal deceleration applied for establishing increased gap in ToC preparation phase.
Rate of adaptation towards the increased headway during ToC preparation.
Whether a coloring scheme shall by applied to indicate the different ToC stages.
Switches on output by specifying an output filename.

Driver State Device Options:

The probability for a vehicle to have a 'driverstate' device
Assign a 'driverstate' device to named vehicles
The 'driverstate' devices are set deterministic using a fraction of 1000
Initial value assigned to the driver's awareness.
Time scale for the error process.
Noise intensity driving the error process.
General scaling coefficient for applying the error to the perceived speed difference (error also scales with distance).
General scaling coefficient for applying the error to the perceived distance (error also scales with distance).
Base threshold for recognizing changes in the speed difference (threshold also scales with distance).
Base threshold for recognizing changes in the headway (threshold also scales with distance).
Minimal admissible value for the driver's awareness.
Maximal reaction time (~action step length) induced by decreased awareness level (reached for awareness=minAwareness).

Bluelight Device Options:

The probability for a vehicle to have a 'bluelight' device
Assign a 'bluelight' device to named vehicles
The 'bluelight' devices are set deterministic using a fraction of 1000
Set the distance at which other drivers react to the blue light and siren sound

FCD Device Options:

The probability for a vehicle to have a 'fcd' device
Assign a 'fcd' device to named vehicles
The 'fcd' devices are set deterministic using a fraction of 1000
Recording begin time for FCD-data
Recording period for FCD-data
Record objects in a radius around equipped vehicles
The probability for a person to have a 'fcd' device
Assign a 'fcd' device to named persons
The 'fcd' devices are set deterministic using a fraction of 1000
Recording period for FCD-data

ElecHybrid Device Options:

The probability for a vehicle to have a 'elechybrid' device
Assign a 'elechybrid' device to named vehicles
The 'elechybrid' devices are set deterministic using a fraction of 1000

Taxi Device Options:

The probability for a vehicle to have a 'taxi' device
Assign a 'taxi' device to named vehicles
The 'taxi' devices are set deterministic using a fraction of 1000
The dispatch algorithm [greedy|greedyClosest|greedyShared|routeExtension|traci]
Write information from the dispatch algorithm to FILE
Load dispatch algorithm parameters in format KEY1:VALUE1[,KEY2:VALUE]
The period between successive calls to the dispatcher
The behavior of idle taxis [stop|randomCircling]
Write information from the idling algorithm to FILE

GLOSA Device Options:

The probability for a vehicle to have a 'glosa' device
Assign a 'glosa' device to named vehicles
The 'glosa' devices are set deterministic using a fraction of 1000
The communication range to the traffic light
The maximum speed factor when approaching a green light
Minimum speed when coasting towards a red light

Tripinfo Device Options:

The probability for a vehicle to have a 'tripinfo' device
Assign a 'tripinfo' device to named vehicles
The 'tripinfo' devices are set deterministic using a fraction of 1000

Vehroutes Device Options:

The probability for a vehicle to have a 'vehroute' device
Assign a 'vehroute' device to named vehicles
The 'vehroute' devices are set deterministic using a fraction of 1000

Friction Device Options:

The probability for a vehicle to have a 'friction' device
Assign a 'friction' device to named vehicles
The 'friction' devices are set deterministic using a fraction of 1000
The measurement noise parameter which can be applied to the friction device
The measurement offset parameter which can be applied to the friction device -> e.g. to force false measurements

TraCI Server Options:

Enables TraCI Server if set
Expected number of connecting clients

Mesoscopic Options:

Enables mesoscopic simulation
Length of an edge segment in mesoscopic simulation
Factor for calculating the net free-free headway time
Factor for calculating the net free-jam headway time
Factor for calculating the jam-free headway time
Factor for calculating the jam-jam headway time
Minimum percentage of occupied space to consider a segment jammed. A negative argument causes thresholds to be computed based on edge speed and tauff (default)
Enable multiple queues at edge ends
Enable separate queues for every lane
Do not build queues (or reduce capacity) for lanes allowing only the given vclasses
Enable mesoscopic traffic light and priority junction handling
Enable mesoscopic traffic light and priority junction handling for saturated links. This prevents faulty traffic lights from hindering flow in low-traffic situations
Apply scaled travel time penalties when driving across tls controlled junctions based on green split instead of checking actual phases
Apply scaled headway penalties when driving across tls controlled junctions based on green split instead of checking actual phases
Apply fixed time penalty when driving across a minor link. When using --meso-junction-control.limited, the penalty is not applied whenever limited control is active.
Enable mesoscopic overtaking
Time interval for rechecking insertion into the next segment after failure

Random Number Options:

Initialises the random number generator with the current system time
Initialises the random number generator with the given value
Number of pre-allocated random number generators to ensure repeatable multi-threaded simulations (should be at least the number of threads for repeatable simulations).

GUI Only Options:

Load visualisation settings from FILE
Quits the GUI when the simulation stops
Start the GUI in gaming mode
Select the game type ('tls', 'drt')
Start the simulation after loading
Use FLOAT in ms as delay between simulation steps
Use TIME[] as times when the simulation should halt
Load edge/lane weights for visualization from FILE
Restart the simulation after ending (demo mode)
Do not load background pictures
Load current viewport from registry
Create initial window with the given x,y size
Create initial window at the given x,y position
The aggregation period for value tracker windows
Start with an OpenSceneGraph view instead of the regular 2D view
Enable overlay for screen recognition
Enable output messages during GUI-Testing
Save gui settings in the given settings output file

EXAMPLES

sumo -b 0 -e 1000 -n net.xml -r routes.xml
start a simulation from time 0 to 1000 with given net and routes
sumo -c munich_config.cfg
start with a configuration file
sumo --help
print help

REPORTING BUGS

Report bugs at <https://github.com/eclipse/sumo/issues>.
Get in contact via <sumo@dlr.de>.


Build features: Linux-5.10.0-19-amd64 x86_64 GNU 12.2.0 None FMI Proj GUI Intl SWIG GDAL FFmpeg OSG GL2PS Eigen
Copyright (C) 2001-2022 German Aerospace Center (DLR) and others; https://sumo.dlr.de

Eclipse SUMO sumo Version 1.15.0 is part of SUMO.
This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v20.html
This program may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Public License 2.0 are satisfied: GNU General Public License, version 2 or later which is available at https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later

December 2022 Eclipse SUMO sumo Version 1.15.0