ECLIPSE(1)

πŸ’– ECLIPSE(1) β€” like, the od2trips era πŸ’–

okay bestie, welcome to the User Commands corner of the manual. This is the page for Eclipse β€” aka the importer of O/D-matrices for the traffic simulation SUMO. Yes it's giving very serious-research-tool, but I'm gonna walk you through it like we're texting at 2am πŸ¦‹


✨ NAME ✨

Eclipse β€” Importer of O/D-matrices for the traffic simulation SUMO. That's it, that's the whole gig πŸ’…


🌸 SYNOPSIS 🌸

od2trips [OPTION]*

πŸŽ€ DESCRIPTION πŸŽ€

Eclipse SUMO od2trips 1.27.1

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

So what does it do? It's the Importer of O/D-matrices for the microscopic, multi-modal traffic simulation β€” and obviously that simulation is SUMO. Lowkey iconic πŸš—βœ¨

βš™οΈ Configuration Options: (the setup era)

  • -c, --configuration-file FILE β€” loads the config you name right at startup. Your whole vibe, pre-loaded.
  • -C, --save-configuration FILE β€” saves your current configuration into FILE.
  • --save-configuration.relative β€” forces relative paths when it's saving the configuration. No absolute-path drama.
  • --save-template FILE β€” saves a configuration template (empty, a lil blank canvas 🎨) into FILE.
  • --save-schema FILE β€” saves the configuration schema into FILE.
  • --save-commented β€” adds comments to the saved template, configuration, or schema. Little notes to your future self 🫢

πŸ“₯ Input Options: (feed me the data)

  • -n, --taz-files FILE β€” loads TAZ (that's districts, and yes also from networks) from FILE(s).
  • -d, --od-matrix-files FILE β€” loads O/D-files from FILE(s).
  • --od-amitran-files FILE β€” loads O/D-matrix in Amitran format from FILE(s).
  • -z, --tazrelation-files FILE β€” loads O/D-matrix in tazRelation format from FILE(s).
  • --tazrelation-attribute STR β€” defines the data attribute used for loading counts. The default is 'count', and honestly the default ate.

πŸ“€ Output Options: (here's what you get back)

  • --write-license β€” puts license info into every output file. Every single one. No skipping πŸ’€
  • --write-metadata β€” writes parsable metadata (configuration etc.) instead of comments.
  • --output-prefix STR β€” a prefix applied to all output files. Special lil string: 'TIME' gets replaced by the current time ⏰
  • --output-suffix STR β€” same energy but at the end. And yes, 'TIME' also 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 β€” sets the standard compression algorithm (currently only for parquet output).
  • --output.format STR β€” sets the standard output format when it can't be derived from the file name. Your choices: 'xml', 'csv', 'parquet'.
  • --output.column-header STR β€” how to derive column headers from attribute names. Options: 'none', 'tag', 'auto', 'plain'.
  • --output.column-separator STR β€” the separator used in CSV output.
  • -H, --human-readable-time β€” writes time values as hour:minute:second or day:hour:minute:second instead of plain seconds. Way nicer to read, ngl.
  • -o, --output-file FILE β€” writes trip definitions into FILE.
  • --flow-output FILE β€” writes flow definitions into FILE.
  • --flow-output.probability β€” writes probabilistic flow instead of evenly spaced flow.
  • --flow-output.poisson β€” writes poisson distributed flow instead of evenly spaced flow.
  • --pedestrians β€” writes pedestrians instead of vehicles 🚢
  • --persontrips β€” writes persontrips instead of vehicles.
  • --persontrips.modes STR[] β€” adds a modes attribute to personTrips.
  • --ignore-vehicle-type β€” does not save vtype information. Just doesn't. Bye πŸ‘‹
  • --junctions β€” writes trips between junctions.

⏳ Time Options: (clock check)

  • -b, --begin TIME β€” defines the begin time. Heads up: previous trips will be discarded.
  • -e, --end TIME β€” defines the end time. Also dramatic: later trips will be discarded. Defaults to the maximum time that SUMO can represent. (Yes, that's absurdly far in the future. It's fine.)

🧠 Processing Options: (the actual brain work)

  • -s, --scale FLOAT β€” scales the loaded flows by FLOAT.
  • --spread.uniform β€” spreads trips uniformly over each time period.
  • --different-source-sink β€” always choose a source and sink edge that are not identical. No round-tripping to the same spot 🫠
  • --vtype STR β€” defines the name of the vehicle type to use.
  • --prefix STR β€” defines the prefix for vehicle names.
  • --timeline STR[] β€” uses STR[] as a timeline definition.
  • --timeline.day-in-hours β€” uses STR as a 24h-timeline definition.
  • --no-step-log β€” disables console output of the current time step. For when the scrolling is too much 😭

🧸 Defaults Options: (the preset slay)

  • --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.

πŸ“’ Report Options: (tell me everything)

  • -v, --verbose β€” switches to verbose output. Spill the tea β˜•
  • --print-options β€” prints option values before processing.
  • -?, --help β€” prints this screen, or selected topics.
  • -V, --version β€” prints the current version.
  • -X, --xml-validation STR β€” sets the schema validation scheme for XML inputs: "never", "local", "auto" or "always".
  • -W, --no-warnings β€” disables output of warnings.
  • --aggregate-warnings INT β€” aggregates warnings of the same type whenever more than INT occur.
  • -l, --log FILE β€” writes all messages to FILE. (Also implies verbose, fyi.)
  • --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 the process ID in front of all messages.
  • --language STR β€” the language to use in messages 🌍
  • --ignore-errors β€” keeps going even on broken input. Chaotic but brave.

🎲 Random Number Options: (rng girlies rise)

  • --random β€” initialises the random number generator with the current system time.
  • --seed INT β€” initialises the random number generator with the value you give it.

🌈 EXAMPLES 🌈

okay here's the moment, the demo, the main character scene:

od2trips -c <CONFIGURATION>

run with configuration file. That's literally it. Chef's kiss πŸ‘‘


πŸ› REPORTING BUGS πŸ›

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

Wanna get in contact? <sumo@dlr.de> β€” they're friendly, 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 od2trips 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 that's the whole page bestie, go import some matrices πŸ’–

Eclipse SUMO od2trips 1.27.1 β€” August 2026 β€” ECLIPSE(1) πŸ¦‹βœ¨

πŸ“¦ where this page comes from