ECLIPSE(1)

📦
version 1.27.1 · 7 versions
, in ubuntu stonking

ECLIPSE(1) — the manual page, but make it cute ✨

okay bestie, so real talk: we're looking at Eclipse, and yeah it's filed under User Commands in the manual, section 1. Slay. I folded the header in up here like a lil name tag because copying it verbatim would be lowkey weird. Everything else? Verbatim facts, immaculate vibes. 🫶

✨ NAME ✨

Eclipse — Import O/D-matrices and trips using macroscopic traffic assignment for SUMO

That's the whole name section and honestly? It ate. You feed it O/D-matrices and trips, it does macroscopic traffic assignment, and it's doing all of this for SUMO. No cap, that's the job description. 💅

🌸 SYNOPSIS 🌸

marouter [OPTION]*

so the invocation is literally just marouter plus however many OPTIONs you want to throw at it — that star means zero or more, bestie, so stack 'em up. 🌈

heads up: the binary you actually run is called marouter, even tho the page is named Eclipse. That's not a typo, that's just the way it is. iykyk 🎀

more parts incoming, don't go anywhere — we are so not done here. 💖

✨ DESCRIPTION ✨

Okay bestie, buckle up 🎀 — this is Eclipse SUMO marouter 1.27.1, and it's the whole vibe for importing O/D-matrices so you can do macroscopic traffic assignment and generate SUMO routes. Like, it takes your origin/destination data and turns it into actual routes. Iconic.

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

Import O/D-matrices for macroscopic traffic assignment to generate SUMO routes. That's the whole job. She assigns, she routes, she serves. 💅

🛠️ Configuration Options

Sitting at the top because she sets the whole tone, no cap.

  • -c, --configuration-file FILE — Loads the named config on startup. Like loading a save file but for routing. 🎮
  • -C, --save-configuration FILE — Saves current configuration into FILE. Preserve the vibes for later.
  • --save-configuration.relative — Enforce relative paths when saving the configuration. Keeps your paths from being extra.
  • --save-template FILE — Saves a configuration template (empty) into FILE. A blank canvas, main character energy. ✨
  • --save-schema FILE — Saves the configuration schema into FILE.
  • --save-commented — Adds comments to saved template, configuration, or schema. Receipts in the comments, so thoughtful.

📥 Input Options

  • -n, --net-file FILE — Use FILE as SUMO-network to route on. This is the map, bestie, you need it. 🗺️
  • -a, --additional-files FILE — Read additional network data (districts, bus stops) from FILE(s). Extra toppings, as many files as your heart desires.
  • -r, --route-files FILE — Read sumo routes, alternatives, flows, and trips from FILE(s). All the good stuff.
  • --phemlight-path FILE — Determines where to load PHEMlight definitions from.
  • --phemlight-year INT — Enable fleet age modelling with the given reference year in PHEMlight5.
  • --phemlight-temperature FLOAT — Set ambient temperature to correct NOx emissions in PHEMlight5. Yes, the temperature really does change the NOx, science said so. 🌡️
  • -w, --weight-files FILE — Read network weights from FILE(s).
  • --lane-weight-files FILE — Read lane-based network weights from FILE(s). Per-lane, we're fancy.
  • -x, --weight-attribute STR — Name of the xml attribute which gives the edge weight.
  • --junction-taz — Initialize a TAZ for every junction to use attributes toJunction and fromJunction.
  • -m, --od-matrix-files FILE — Loads O/D-files from FILE(s). The main quest fr. 🔥
  • --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 — Define data attribute for loading counts (default 'count').
  • --weight-adaption FLOAT — The travel time influence of prior intervals.
  • --taz-param STR[] — Parameter key(s) defining source (and sink) taz.
  • --ignore-taz — Ignore attributes 'fromTaz' and 'toTaz'. Who needs 'em honestly.

📤 Output Options

  • -o, --output-file FILE — Write generated routes to FILE. The moment we've all been waiting for. 💖
  • --vtype-output FILE — Write used vehicle types into separate FILE.
  • --keep-vtype-distributions — Keep vTypeDistribution ids when writing vehicles and their types.
  • --emissions.volumetric-fuel — Return fuel consumption values in (legacy) unit l instead of mg. Legacy, so retro of her.
  • --named-routes — Write vehicles that reference routes by their id.
  • --write-license — Include license info into every output file. Give credit where credit is due, always.
  • --write-metadata — Write parsable metadata (configuration etc.) instead of comments.
  • --output-prefix STR — Prefix which is applied to all output files. The special string 'TIME' is replaced by the current time. ⏰
  • --output-suffix STR — Suffix which is applied to all output files. The special string 'TIME' is 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 not derivable 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 — Separator in CSV output.
  • -H, --human-readable-time — Write time values as hour:minute:second or day:hour:minute:second rather than seconds. Because clock time hits different.
  • --ignore-vehicle-type — Does not save vtype information.
  • --netload-output FILE — Writes edge loads and final costs into FILE.
  • --all-pairs-output FILE — Writes complete distance matrix into FILE. Every single pair, thorough queen. 👑
  • --exit-times — Write exit times (weights) for each edge.

⚙️ Processing Options

  • --max-alternatives INT — Prune the number of alternatives to INT.
  • --with-taz — Use origin and destination zones (districts) for in- and output.
  • --routing-threads INT — The number of parallel execution threads used for routing. Multithreading the house down.
  • --routing-algorithm STR — Select among routing algorithms ['dijkstra', 'astar', 'CH', 'CHWrapper'].
  • --restriction-params STR[] — Comma separated list of param keys to compare for additional restrictions.
  • --weights.interpolate — Interpolate edge weights at interval boundaries.
  • --weights.expand — Expand the end of the last loaded weight interval to infinity. ♾️
  • --weights.minor-penalty FLOAT — Apply the given time penalty when computing routing costs for minor-link internal lanes.
  • --weights.tls-penalty FLOAT — Apply the given time penalty when computing routing costs across a traffic light. 🚦
  • --weights.turnaround-penalty FLOAT — Apply the given time penalty when computing routing costs for turnaround internal lanes.
  • --weights.reversal-penalty FLOAT — Apply the given time penalty when computing routing costs for train reversal. Negative values disable reversal.
  • --aggregation-interval TIME — Defines the time interval when aggregating single vehicle input; Defaults to one hour.
  • --capacities.default — Ignore edge priorities when calculating capacities and restraints.
  • --weights.priority-factor FLOAT — Consider edge priorities in addition to travel times, weighted by factor.
  • --bulk-routing.vtypes — Aggregate routing queries with the same origin for different vehicle types.
  • --weight-period TIME — Aggregation period for the given weight files; triggers rebuilding of Contraction Hierarchy.
  • -s, --scale FLOAT — Scales the loaded flows by FLOAT.
  • --vtype STR — Defines the name of the vehicle type to use.
  • --prefix STR — Defines the prefix for vehicle flow names.
  • --timeline STR[] — Uses STR[] as a timeline definition.
  • --timeline.day-in-hours — Uses STR as a 24h-timeline definition. 🕛
  • --additive-traffic — Keep traffic flows of all time slots in the net.
  • --assignment-method STR — Choose a assignment method: incremental, UE or SUE.
  • --tolerance FLOAT — Use FLOAT as tolerance when checking for SUE stability.
  • --left-turn-penalty FLOAT — Use left-turn penalty FLOAT to calculate link travel time when searching routes. Left turns are the villain, always have been.
  • --paths INT — Use INTEGER as the number of paths needed to be searched for each OD pair at each iteration.
  • --paths.penalty FLOAT — Penalize existing routes with FLOAT to find secondary routes.
  • --upperbound FLOAT — Use FLOAT as the upper bound to determine auxiliary link cost.
  • --lowerbound FLOAT — Use FLOAT as the lower bound to determine auxiliary link cost.
  • -i, --max-iterations INT — maximal number of iterations for new route searching in incremental and stochastic user assignment.
  • --max-inner-iterations INT — maximal number of inner iterations for user equilibrium calculation in the stochastic user assignment.

Route choice girlies, this part is FOR you:

  • --route-choice-method STR — Choose a route choice method: gawron, logit, or lohse.
  • --gawron.beta FLOAT — Use FLOAT as Gawron's beta.
  • --gawron.a FLOAT — Use FLOAT as Gawron's a.
  • --keep-all-routes — Save routes with near zero probability.
  • --skip-new-routes — Only reuse routes from input, do not calculate new ones.
  • --logit.beta FLOAT — Use FLOAT as (c-)logit's beta for the commonality factor.
  • --logit.gamma FLOAT — Use FLOAT as (c-)logit's gamma for the commonality factor.
  • --logit.theta FLOAT — Use FLOAT as (c-)logit's theta.

💅 Defaults Options

  • --defaults-override — Defaults will override given values. She's bossy like that and we respect it.
  • --flow-output.departlane STR — Assigns a default depart lane.
  • --flow-output.departpos STR — Assigns a default depart position.
  • --flow-output.departspeed STR — Assigns a default depart speed.
  • --flow-output.arrivallane STR — Assigns a default arrival lane.
  • --flow-output.arrivalpos STR — Assigns a default arrival position.
  • --flow-output.arrivalspeed STR — Assigns a default arrival speed.

⏰ Time Options

  • -b, --begin TIME — Defines the begin time; Previous trips will be discarded. Gone, deleted, not invited.
  • -e, --end TIME — Defines the end time; Later trips will be discarded; Defaults to the maximum time that SUMO can represent. She really means the MAX max.

📢 Report Options

  • -v, --verbose — Switches to verbose output. Tell me EVERYTHING. 🗣️
  • --print-options — Prints option values before processing.
  • -?, --help — Prints this screen or selected topics.
  • -V, --version — Prints the current version.
  • -X, --xml-validation STR — Set schema validation scheme of XML inputs ("never", "local", "auto" or "always").
  • --xml-validation.net STR — Set schema validation scheme of SUMO network inputs ("never", "local", "auto" or "always").
  • --xml-validation.routes STR — Set schema validation scheme of SUMO route 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 (implies verbose).
  • --message-log FILE — Writes all non-error messages to FILE (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. 🌐
  • --ignore-errors — Continue if a route could not be build. She just keeps going, resilience queen.
  • --stats-period INT — Defines how often statistics shall be printed.
  • --no-step-log — Disable console output of route parsing step.

🎲 Random Number Options

  • --random — Initialises the random number generator with the current system time. Chaos era unlocked. 🎀
  • --seed INT — Initialises the random number generator with the given value. Reproducible, so demure, so mindful. ✨

🌟 EXAMPLES

Copy-paste and go, bestie:

marouter -c <CONFIGURATION>

run routing with options from file — that's it, that's the vibe. 💖

💅 REPORTING BUGS 💅

Okay bestie, if something's acting up, you do NOT just suffer in silence, you go tell the devs. Fr fr.

And because we love receipts, here's the exact build deets of this program, shown exactly as it prints them:

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 marouter 1.27.1 is part of SUMO, bestie. Iconic lineage, honestly.

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 <https://www.eclipse.org/legal/epl-v20.html>.

Lowkey important, so read it twice: 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>.

And for the licensing girlies who live for a short identifier:

SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later

okay that's the whole page bestie, you made it to the end, slay 💖

Tiny lil sign-off, as a treat: this page is for Eclipse SUMO marouter 1.27.1, dated August 2026, and in the man-page system it lives under the name ECLIPSE(1). Go route something gorgeous, you absolute icon 👑✨

📦 where this page comes from