ECLIPSE(1)

📦
version 1.27.1 · 7 versions
, in ubuntu stonking

✨ ECLIPSE(1) ✨

okay bestie, welcome to the User Commands section of the manual, because today we're talking about Eclipse — the route-building queen. buckle up, this one has a lot of options and I mean a LOT. 💅

🌸 NAME 🌸

Eclipse — Builds vehicle routes for SUMO using detector values

no cap, that's the whole job description. she builds routes. from detectors. iconic. 👑

🦋 SYNOPSIS 🦋

dfrouter [OPTION]*

yes the binary is called dfrouter even though the page is ECLIPSE. we don't question the lore. 🫶

💖 DESCRIPTION 💖

Eclipse SUMO dfrouter 1.27.1

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

Builds vehicle routes for SUMO using detector values.

that's it, that's the vibe. detector data goes in, vehicle routes come out, main character energy fr fr. 🔥

🎀 Configuration Options 🎀

  • -c, --configuration-file FILE — loads the named config on startup
  • -C, --save-configuration FILE — saves the current configuration into FILE
  • --save-configuration.relative — enforces relative paths when saving the configuration
  • --save-template FILE — saves a configuration template (empty, like, literally blank bestie) into FILE
  • --save-schema FILE — saves the configuration schema into FILE
  • --save-commented — adds comments to a saved template, configuration, or schema

🍓 Input Options 🍓

  • -n, --net-file FILE — loads the SUMO-network FILE
  • -d, --detector-files FILE — loads detector descriptions from FILE
  • -f, --measure-files FILE — loads detector flows from FILE(s) (yes, plural, she's greedy 💜)

🌈 Output Options 🌈

  • --write-license — includes license info into 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 — defines the number of digits after the comma for floating point output
  • --precision.geo INT — defines the number of digits after the comma for lon,lat output
  • --output.compression STR — defines the standard compression algorithm (currently only for parquet output)
  • --output.format STR — defines 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 — write time values as hour:minute:second or day:hour:minute:second instead of just seconds
  • -o, --routes-output FILE — saves the computed routes to FILE
  • --routes-for-all — forces dfrouter to compute routes for in-between detectors
  • --detector-output FILE — saves typed detectors to FILE
  • --detectors-poi-output FILE — saves detector positions as pois to FILE
  • --emitters-output FILE — saves emitter definitions for source detectors to FILE
  • --vtype — add vehicle types to the emitters file (PKW, LKW)
  • --vtype-output FILE — write generated vehicle types into a separate FILE instead of including them in the emitters-output
  • --emitters-poi-output FILE — saves emitter positions as pois to FILE
  • --variable-speed-sign-output FILE — saves variable seed sign definitions for sink detectors to FILE
  • --end-reroute-output FILE — saves rerouter definitions for sink detectors to FILE
  • --validation-output FILE — write induction loop definitions for the given detector positions to FILE
  • --validation-output.add-sources — add source detectors to the validation output

🧚 Processing Options 🧚

  • --guess-empty-flows — derive missing flow values from upstream or downstream. heads up bestie: this is literally marked (not working!) 😭
  • -h, --highway-mode — switches to highway-mode 🛣️
  • --ignore-invalid-detectors — only warn about unparseable detectors
  • --revalidate-detectors — recomputes detector types even if they were given
  • --revalidate-routes — recomputes routes even if they were given
  • --keep-unfinished-routes — keeps routes even if they've exhausted max-search-depth
  • --keep-longer-routes — keeps routes even if a shorter one exists
  • --max-search-depth INT — number of edges to follow a route without passing a detector
  • --emissions-only — writes only emission times
  • --disallowed-edges STR[] — do not route on these edges 🚫
  • --vclass STR — only route on edges allowing the given vclass
  • --keep-turnarounds — allow turnarounds as route continuations
  • --min-route-length FLOAT — minimum distance in meters between the start and end node of every route
  • --randomize-flows — generate random departure times for emitted vehicles 🎲
  • --time-factor TIME — multiply flow times with TIME to get seconds
  • --time-offset TIME — subtracts TIME seconds from the (scaled) flow times
  • --time-step TIME — expected distance between two successive data sets
  • --calibrator-output — write calibrators to FILE
  • --include-unused-routes — include routes in the output which have no vehicles
  • --revalidate-flows — checks whether detectors with a calculated flow of 0 can attract additional traffic
  • --remove-empty-detectors — removes empty detectors from the list
  • --strict-sources — whether edges with unknown status can prevent an edge from becoming a source
  • --respect-concurrent-inflows — try to determine further inflows to an inbetween detector when computing split probabilities
  • --scale FLOAT — scale factor for flows

🌟 Defaults Options 🌟

  • --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
  • --speeddev FLOAT — the default speed deviation of vehicles

⏳ Time Options ⏳

  • -b, --begin TIME — defines the begin time; previous defs will be discarded 💀
  • -e, --end TIME — defines the end time; later defs will be discarded; defaults to one day

📢 Report Options 📢

  • -v, --verbose — switches to verbose output
  • --print-options — prints option values before processing
  • -?, --help — prints this screen (the very one you're reading, hiiii 🫶) or selected topics
  • -V, --version — prints the current version
  • -X, --xml-validation STR — set the schema validation scheme of XML inputs ("never", "local", "auto" or "always")
  • --xml-validation.net STR — set the schema validation scheme of SUMO network inputs ("never", "local", "auto" or "always")
  • -W, --no-warnings — disables output of warnings
  • --aggregate-warnings INT — aggregate warnings of the same type whenever more than INT occur
  • -l, --log FILE — writes all messages to FILE (this implies verbose)
  • --message-log FILE — writes all non-error messages to FILE (also implies verbose)
  • --error-log FILE — writes all warnings and errors to FILE
  • --log.timestamps — writes timestamps in front of all messages
  • --log.processid — writes process ID in front of all messages
  • --language STR — language to use in messages
  • --report-empty-detectors — lists detectors with no flow (enable -v for this one, bestie)
  • --print-absolute-flows — prints aggregated detector flows
  • --no-step-log — disable console output of the route parsing step

🎲 Random Number Options 🎲

  • --random — initialises the random number generator with the current system time
  • --seed INT — initialises the random number generator with the given value

🌸 EXAMPLES 🌸

dfrouter -c <CONFIGURATION>

run routing with options from file ✨

💅 REPORTING BUGS 💅

found something cursed? report bugs at <https://github.com/eclipse-sumo/sumo/issues>.

want to actually talk to a human? get in contact via <sumo@dlr.de>. they're lovely, promise. 🫶

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 dfrouter 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

and that's the whole page, bestie 💖 this is Eclipse SUMO dfrouter 1.27.1, living its best life in the ECLIPSE(1) section, dated August 2026. go build some routes, you absolute icon. 👑✨🦋

📦 where this page comes from