ECLIPSE(1)

📦
version 1.27.1 · 7 versions
, in ubuntu stonking

🦋 ECLIPSE(1) — User Commands 🦋

okay so first things first, the manual name is Eclipse and this whole page is literally about duarouter, the little icon it is. Welcome to part 1 bestie, sit down, get a snack 🍓

💖 NAME 💖

Eclipse — the shortest path router and DUE computer for the microscopic traffic simulation SUMO. That's it, that's the whole identity, and honestly? main character energy. 👑

✨ SYNOPSIS ✨

duarouter [OPTION]*

🌈 DESCRIPTION 🌈

It's Eclipse SUMO duarouter 1.27.1, no cap.

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

The vibe: shortest path router and DUE computer for the microscopic, multi-modal traffic

simulation SUMO.

That's fr fr it. Now let's get into the actual options because there are... so many. Buckle up. 🎀

🎀 Configuration Options 🎀

like, the settings section. outfit check for your run.

  • -c, --configuration-file FILE — loads the named config when it starts up ✨
  • -C, --save-configuration FILE — saves whatever config you're running rn into FILE
  • --save-configuration.relative — forces relative paths when it saves the configuration (no sneaky absolute paths)
  • --save-template FILE — drops an empty configuration template into FILE
  • --save-schema FILE — saves the configuration schema into FILE
  • --save-commented — adds comments to whatever you saved: template, config, or schema 💅

🦋 Input Options 🦋

what you're feeding it. she needs her data.

  • -n, --net-file FILE — use FILE as the SUMO-network to route on 🌐
  • -a, --additional-files FILE — read additional network data (districts, bus stops) from FILE(s)
  • -r, --route-files FILE — read sumo routes, alternatives, flows, and trips from FILE(s)
  • --phemlight-path FILE — decides where PHEMlight definitions get loaded from
  • --phemlight-year INT — turns on fleet age modelling with the given reference year in PHEMlight5
  • --phemlight-temperature FLOAT — sets ambient temperature so the NOx emissions get corrected in PHEMlight5 🌡️
  • -w, --weight-files FILE — read network weights from FILE(s)
  • --lane-weight-files FILE — read lane-based network weights from FILE(s)
  • -x, --weight-attribute STR — the name of the xml attribute that gives the edge weight
  • --junction-taz — initializes a TAZ for every junction so it can use the attributes toJunction and fromJunction

💖 Output Options 💖

where the results go, aka the glow-up reveal ✨

  • -o, --output-file FILE — write the generated routes to FILE
  • --vtype-output FILE — write the used vehicle types into a separate FILE
  • --keep-vtype-distributions — keeps vTypeDistribution ids when writing vehicles and their types
  • --emissions.volumetric-fuel — returns fuel consumption values in the (legacy) unit l instead of mg
  • --named-routes — writes vehicles that reference routes by their id
  • --write-license — includes license info in every output file 📜
  • --write-metadata — writes parsable metadata (configuration etc.) instead of comments
  • --output-prefix STR — a prefix applied to all output files. The special string 'TIME' gets replaced by the current time ⏰
  • --output-suffix STR — a suffix applied to all output files. The special string 'TIME' gets replaced by the current time ⏰
  • --precision INT — how many digits after the comma for floating point output
  • --precision.geo INT — how many digits after the comma for lon,lat output
  • --output.compression STR — the standard compression algorithm (currently only for parquet output)
  • --output.format STR — the standard output format if it can't be derived from the file name ('xml', 'csv', 'parquet')
  • --output.column-header STR — how to derive column headers from attribute names ('none', 'tag', 'auto', 'plain')
  • --output.column-separator STR — the separator in CSV output
  • -H, --human-readable-time — writes time values as hour:minute:second or day:hour:minute:second instead of plain seconds 🕐
  • --alternatives-output FILE — write the generated route alternatives to FILE
  • --intermodal-network-output FILE — write edge splits and connectivity to FILE
  • --intermodal-weight-output FILE — write intermodal edges with lengths and travel times to FILE
  • --write-trips — write trips instead of vehicles (for validating trip input)
  • --write-trips.geo — write trips with geo-coordinates
  • --write-trips.junctions — write trips with fromJunction and toJunction
  • --write-costs — includes the cost attribute in route output
  • --exit-times — write exit times (weights) for each edge
  • --route-length — includes the total route length in the output 📏

🔥 Processing Options 🔥

the actual brain work. this is where she thinks.

  • --max-alternatives INT — prunes the number of alternatives down to INT
  • --with-taz — use origin and destination zones (districts) for in- and output
  • --unsorted-input — assumes the input is unsorted
  • -s, --route-steps TIME — load routes for the next number of seconds ahead
  • --no-internal-links — disables (junction) internal links
  • --randomize-flows — generates random departure times for flow input 🎲
  • --remove-loops — removes loops within the route; removes turnarounds at the start and end of the route
  • --repair — tries to correct a false route
  • --repair.from — tries to correct an invalid starting edge by using the first usable edge instead
  • --repair.to — tries to correct an invalid destination edge by using the last usable edge instead
  • --repair.max-detour-factor FLOAT — backtracks on the route if the detour is longer than the gap by FACTOR
  • --mapmatch.distance FLOAT — maximum distance when mapping input coordinates (fromXY etc.) to the road network
  • --mapmatch.junctions — matches positions to junctions instead of edges
  • --mapmatch.taz — matches positions to taz instead of edges
  • --bulk-routing — aggregates routing queries with the same origin
  • --routing-threads INT — the number of parallel execution threads used for routing ⚡
  • --routing-algorithm STR — pick a routing algorithm among ['dijkstra', 'astar', 'CH', 'CHWrapper']
  • --restriction-params STR[] — comma separated list of param keys to compare for additional restrictions
  • --weights.interpolate — interpolates edge weights at interval boundaries
  • --weights.expand — expands the end of the last loaded weight interval to infinity ♾️
  • --weights.minor-penalty FLOAT — applies the given time penalty when computing routing costs for minor-link internal lanes
  • --weights.tls-penalty FLOAT — applies the given time penalty when computing routing costs across a traffic light
  • --weights.turnaround-penalty FLOAT — applies the given time penalty when computing routing costs for turnaround internal lanes
  • --weights.reversal-penalty FLOAT — applies the given time penalty when computing routing costs for train reversal. Negative values disable reversal
  • --weights.random-factor FLOAT — edge weights for routing get dynamically disturbed by a random factor drawn uniformly from [1,FLOAT)
  • --weight-period TIME — aggregation period for the given weight files; triggers rebuilding of Contraction Hierarchy
  • --weights.priority-factor FLOAT — considers edge priorities in addition to travel times, weighted by factor
  • --astar.all-distances FILE — initialize the lookup table for astar from the given file (generated by marouter --all-pairs-output)
  • --astar.landmark-distances FILE — initialize the lookup table for the astar ALT-variant from the given file
  • --astar.save-landmark-distances FILE — save the lookup table for the astar ALT-variant to the given file
  • --scale FLOAT — scales demand by the given factor (by discarding or duplicating vehicles)
  • --scale-suffix STR — suffix added when creating ids for cloned vehicles
  • --taxi.vclasses STR[] — network permissions that can be accessed by taxis 🚕
  • --gawron.beta FLOAT — use FLOAT as Gawron's beta
  • --gawron.a FLOAT — use FLOAT as Gawron's a
  • --keep-all-routes — saves routes with near zero probability
  • --skip-new-routes — only reuses routes from input, does not calculate new ones
  • --keep-route-probability FLOAT — the probability of keeping the old route
  • --ptline-routing — routes all public transport input 🚌
  • --keep-flows — writes flows instead of expanding them into vehicles
  • --route-choice-method STR — choose a route choice method: gawron, logit, or lohse
  • --logit — use the c-logit model (deprecated in favor of --route-choice-method logit)
  • --logit.beta FLOAT — use FLOAT as logit's beta
  • --logit.gamma FLOAT — use FLOAT as logit's gamma
  • --logit.theta FLOAT — use FLOAT as logit's theta (negative values mean auto-estimation)
  • --persontrip.walkfactor FLOAT — use FLOAT as a factor on pedestrian maximum speed during intermodal routing 🚶
  • --persontrip.walk-opposite-factor FLOAT — use FLOAT as a factor on walking speed against vehicle traffic direction
  • --persontrip.transfer.car-walk STR[] — where mode changes from car to walking are allowed (possible values: 'parkingAreas', 'ptStops', 'allJunctions' and combinations)
  • --persontrip.transfer.taxi-walk STR[] — where taxis can drop off customers ('allJunctions, 'ptStops')
  • --persontrip.transfer.walk-taxi STR[] — where taxis can pick up customers ('allJunctions, 'ptStops')
  • --persontrip.taxi.waiting-time TIME — estimated time for taxi pickup
  • --persontrip.ride-public-line — only use the intended public transport line rather than any alternative line that stops at the destination
  • --railway.max-train-length FLOAT — use FLOAT as a maximum train length when initializing the railway router 🚆
  • --max-traveltime TIME — declares routing failure if traveltime exceeds the given positive TIME
ngl that section was a lot. hydrate. 💧

🧚 Defaults Options 🧚

the fallback fits. if nothing else is specified, these are the lewks.

  • --departlane STR — assigns a default depart lane
  • --departpos STR — assigns a default depart position
  • --departspeed STR — assigns a default depart speed
  • --arrivallane STR — assigns a default arrival lane
  • --arrivalpos STR — assigns a default arrival position
  • --arrivalspeed STR — assigns a default arrival speed
  • --defaults-override — defaults will override given values

⏰ Time Options ⏰

when does the little simulation wake up and when does it go to bed.

  • -b, --begin TIME — defines the begin time; previous trips will be discarded 🗑️
  • -e, --end TIME — defines the end time; later trips will be discarded; defaults to the maximum time that SUMO can represent

👑 Report Options 👑

how chatty she is.

  • -v, --verbose — switches to verbose output 🗣️
  • --print-options — prints option values before processing

and that's part 1, but bestie we are NOT done — more of this absolute novel is coming. stay tuned 💫

  • -?, --help — prints this very screen (or just the topics you asked for) 💖 like babe, it's the built-in cheat sheet, use ittt
  • -V, --version — prints the current version, one line, no drama ✨
  • -X, --xml-validation _STR_ — sets the schema validation scheme for XML inputs. your options are "never", "local", "auto" or "always" 👑
  • --xml-validation.net _STR_ — same deal but for SUMO network inputs: "never", "local", "auto" or "always" 🌐
  • --xml-validation.routes _STR_ — and again for SUMO route inputs: "never", "local", "auto" or "always" 🛣️
  • -W, --no-warnings — shuts warning output all the way off 🙈 (living in bliss fr)
  • --aggregate-warnings _INT_ — whenever more than _INT_ warnings of the same type show up, it bundles them together so your terminal doesn't spiral 💀
  • -l, --log _FILE_ — writes all messages to _FILE_ (and yes, it implies verbose 👀)
  • --message-log _FILE_ — writes all the non-error messages to _FILE_ (also implies verbose)
  • --error-log _FILE_ — writes all warnings and errors to _FILE_ 🔥
  • --log.timestamps — sticks timestamps in front of every message ⏰
  • --log.processid — sticks the process ID in front of every message 🆔
  • --language _STR_ — the language to use in messages 🌸
  • --ignore-errors — keeps going even if a route could not be build 🫶 (yes, "build", that's the page's wording, not mine)
  • --stats-period _INT_ — defines how often the statistics get printed 📊
  • --no-step-log — kills the console output of the route parsing step 🤫

🎲 Random Number Options 🎲

it's giving chaos theory but make it reproducible ✨

  • --random — initialises the random number generator with the current system time 🕰️ (so every run is a lil different, main character energy)
  • --seed _INT_ — initialises the random number generator with the given value 🎀 (feed it the same number, get the same run — that's the whole point bestie)

📚 EXAMPLES 📚

duarouter -c <CONFIGURATION>

run routing with options from file 💅 that's it, that's the whole vibe — point it at a config and let it cook 🔥

🐛 REPORTING BUGS 🐛

found something cursed? report bugs at <https://github.com/eclipse-sumo/sumo/issues> and get in contact via <sumo@dlr.de> 💌

Build features: Linux-6.8.0-139-generic x86_64 GNU 15.3.0 None
FMI Proj GUI Intl SWIG Eigen GDAL FFmpeg OSG GL2PS
Copyright (C) 2001-2026 German Aerospace Center (DLR) and others;
https://sumo.dlr.de

Eclipse SUMO duarouter 1.27.1 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 🫡

okay so that's a whole lot of license lore, but basically: it's open, it's licensed, periodt 💅

and that's the page bestie, we made it 🎀 this one's Eclipse SUMO duarouter 1.27.1, last touched August 2026, living in section ECLIPSE(1) of your manual 🦋 go route something iconic ✨

📦 where this page comes from