ECLIPSE(1)

📦
version 1.27.1 · 7 versions
, in ubuntu stonking

💅 ECLIPSE(1) — the emissionsMap glow-up

okay bestie, welcome to the User Commands section, this is the ECLIPSE(1) page and it's all about that emissions map life. grab a strawberry 🍓 and let's go.

✨ NAME ✨

Eclipse — builds and writes an emissions map for SUMO's emission models. that's it, that's the job, and it does it gorgeously 💖

🦋 SYNOPSIS 🦋

emissionsMap [OPTION]*

literally just emissionsMap plus however many options you want. options go brrr ✨

🌸 DESCRIPTION 🌸

Eclipse SUMO emissionsMap 1.27.1

Copyright (C) 2001-2026 German Aerospace Center (DLR) and others; <https://sumo.dlr.de> — iconic, we love a whole aerospace center 👑

So what does it do? It builds and writes an emissions map for SUMO's emission models. that's the whole vibe. it's giving "scientific instrument but make it cute". no cap 🌈

🎀 Configuration Options 🎀

these are your setup girlies, they handle the config situation:

  • -c, --configuration-file FILE — loads up the named config when it starts up. bestie hands you the file, you read it. periodt.
  • -C, --save-configuration FILE — takes your current configuration and saves it into FILE. snapshot your settings, preserve the moment 📸
  • --save-configuration.relative — forces relative paths while saving the configuration. keep it local, keep it humble 💅
  • --save-template FILE — saves an empty configuration template into FILE. it's a blank canvas, a fresh start, main character energy ✨
  • --save-schema FILE — saves the configuration schema into FILE.
  • --save-commented — adds comments to whatever you saved: template, configuration, or schema. because good code has ✨notes✨

🧚 Input Options 🧚

where does the data come from? right here:

  • --additional-files FILE — loads emission parameters (the vTypes, iykyk) from FILE(s). yes plural, you can load a whole squad.
  • --vtype STR — defines the vehicle type to use for emission parameters. pick your ride 🚗

🔥 Processing Options 🔥

this is where the actual map-building happens, and honestly? the way these boundaries get defined... obsessed.

  • -i, --iterate — if set, maps for all available emissions get written. all of them. every single one. we go feral 💀
  • -e, --emission-class STR — defines the name of the emission class to generate the map for.
  • --v-min FLOAT — the minimum velocity boundary of the map to generate, in m/s.
  • --v-max FLOAT — the maximum velocity boundary of the map to generate, in m/s.
  • --v-step FLOAT — the velocity step size, in m/s.
  • --a-min FLOAT — the minimum acceleration boundary of the map to generate, in m/s^2.
  • --a-max FLOAT — the maximum acceleration boundary of the map to generate, in m/s^2.
  • --a-step FLOAT — the acceleration step size, in m/s^2.
  • --s-min FLOAT — the minimum slope boundary of the map to generate, in deg.
  • --s-max FLOAT — the maximum slope boundary of the map to generate, in deg.
  • --s-step FLOAT — the slope step size, in deg.

look at that symmetry. min, max, step, min, max, step. structurally flawless 🎀

💜 Output Options 💜

where the magic lands on disk:

  • -o, --output STR — defines the file to write the map(s) into, or the path if --iterate was set. your destination awaits 🛬
  • --write-license — include license info into every output file. legally iconic.
  • --write-metadata — write 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' also gets replaced by the current time here. ⏰
  • --precision INT — the number of digits after the comma for floating point output.
  • --precision.geo INT — 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 used in CSV output.
  • -H, --human-readable-time — writes time values as hour:minute:second or day:hour:minute:second instead of just seconds. for the girlies who don't want to do mental math 🧮💅

💚 Emissions Options 💚

the actual emissions content, the whole point:

  • --emissions.volumetric-fuel — returns fuel consumption values in the (legacy) unit l instead of mg. legacy, bestie. retro. vintage. 🕰️
  • --phemlight-path FILE — determines where to load PHEMlight definitions from.
  • --phemlight-year INT — enables fleet age modelling with the given reference year in PHEMlight5.
  • --phemlight-temperature FLOAT — sets the ambient temperature to correct NOx emissions in PHEMlight5. 🌡️

🩷 Report Options 🩷

how this program talks to you, and how loud it is:

  • -v, --verbose — switches to verbose output. it will not shut up and we love that for it 🗣️
  • --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. ignorance is bliss, slay
  • --aggregate-warnings INT — aggregates warnings of the same type whenever more than INT of them occur. crowd control 🫶
  • -l, --log FILE — writes all messages to FILE (and 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 the process ID in front of all messages.
  • --language STR — the language to use in messages. 🌍

🙈 REPORTING BUGS 🙈

found a bug? report it at <https://github.com/eclipse-sumo/sumo/issues>. get in contact via <sumo@dlr.de>. don't be shy, they want to hear from you 🫶

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 emissionsMap 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 the whole page bestie, every last flag, every last legal line, nothing skipped, nothing dropped 💖 Eclipse SUMO emissionsMap 1.27.1 — that's the version, it's dated August 2026, and it lives at the bottom of ECLIPSE(1). go build an emissions map, you absolute legend 👑✨🌻

📦 where this page comes from