.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH ECLIPSE "1" "March 2024" "Eclipse SUMO jtrrouter Version 1.18.0" "User Commands"
.SH NAME
Eclipse \- Router for the microscopic traffic simulation SUMO based on junction turning ratios
.SH SYNOPSIS
.B jtrrouter
[\fI\,OPTION\/\fR]\fI\,*\/\fR
.SH DESCRIPTION
Eclipse SUMO jtrrouter Version 1.18.0
.IP
Copyright (C) 2001\-2023 German Aerospace Center (DLR) and others; https://sumo.dlr.de
.PP
Router for the microscopic, multi\-modal traffic simulation SUMO based on
.IP
junction turning ratios.
.SS "Configuration Options:"
.TP
\fB\-c\fR, \fB\-\-configuration\-file\fR FILE
Loads the named config on startup
.TP
\fB\-C\fR, \fB\-\-save\-configuration\fR FILE
Saves current configuration into FILE
.TP
\fB\-\-save\-configuration\fR.relative
Enforce relative paths when saving the
configuration
.TP
\fB\-\-save\-template\fR FILE
Saves a configuration template (empty) into
FILE
.TP
\fB\-\-save\-schema\fR FILE
Saves the configuration schema into FILE
.TP
\fB\-\-save\-commented\fR
Adds comments to saved template,
configuration, or schema
.SS "Input Options:"
.TP
\fB\-n\fR, \fB\-\-net\-file\fR FILE
Use FILE as SUMO\-network to route on
.TP
\fB\-a\fR, \fB\-\-additional\-files\fR FILE
Read additional network data (districts, bus
stops) from FILE(s)
.TP
\fB\-r\fR, \fB\-\-route\-files\fR FILE
Read sumo routes, alternatives, flows, and
trips from FILE(s)
.TP
\fB\-\-phemlight\-path\fR FILE
Determines where to load PHEMlight
definitions from
.TP
\fB\-\-phemlight\-year\fR INT
Enable fleet age modelling with the given
reference year in PHEMlight5
.TP
\fB\-\-phemlight\-temperature\fR FLOAT
Set ambient temperature to correct NOx
emissions in PHEMlight5
.TP
\fB\-\-junction\-taz\fR
Initialize a TAZ for every junction to use
attributes toJunction and fromJunction
.TP
\fB\-t\fR, \fB\-\-turn\-ratio\-files\fR FILE
Read turning ratios from FILE(s)
.SS "Output Options:"
.TP
\fB\-o\fR, \fB\-\-output\-file\fR FILE
Write generated routes to FILE
.TP
\fB\-\-vtype\-output\fR FILE
Write used vehicle types into separate FILE
.TP
\fB\-\-keep\-vtype\-distributions\fR
Keep vTypeDistribution ids when writing
vehicles and their types
.TP
\fB\-\-emissions\fR.volumetric\-fuel
Return fuel consumption values in (legacy)
unit l instead of mg
.TP
\fB\-\-named\-routes\fR
Write vehicles that reference routes by
their id
.TP
\fB\-\-write\-license\fR
Include license info into every output file
.TP
\fB\-\-output\-prefix\fR STR
Prefix which is applied to all output files.
The special string 'TIME' is replaced by the
current time.
.TP
\fB\-\-precision\fR INT
Defines the number of digits after the comma
for floating point output
.TP
\fB\-\-precision\fR.geo INT
Defines the number of digits after the comma
for lon,lat output
.TP
\fB\-H\fR, \fB\-\-human\-readable\-time\fR
Write time values as hour:minute:second or
day:hour:minute:second rather than seconds
.TP
\fB\-\-exit\-times\fR
Write exit times (weights) for each edge
.SS "Processing Options:"
.TP
\fB\-\-max\-alternatives\fR INT
Prune the number of alternatives to INT
.TP
\fB\-\-with\-taz\fR
Use origin and destination zones (districts)
for in\- and output
.TP
\fB\-\-unsorted\-input\fR
Assume input is unsorted
.TP
\fB\-s\fR, \fB\-\-route\-steps\fR TIME
Load routes for the next number of seconds
ahead
.TP
\fB\-\-no\-internal\-links\fR
Disable (junction) internal links
.TP
\fB\-\-randomize\-flows\fR
generate random departure times for flow
input
.TP
\fB\-\-remove\-loops\fR
Remove loops within the route;
Remove turnarounds at start and end of the
route
.TP
\fB\-\-repair\fR
Tries to correct a false route
.TP
\fB\-\-repair\fR.from
Tries to correct an invalid starting edge by
using the first usable edge instead
.TP
\fB\-\-repair\fR.to
Tries to correct an invalid destination edge
by using the last usable edge instead
.TP
\fB\-\-mapmatch\fR.distance FLOAT
Maximum distance when mapping input
coordinates (fromXY etc.) to the road
network
.TP
\fB\-\-mapmatch\fR.junctions
Match positions to junctions instead of
edges
.TP
\fB\-\-bulk\-routing\fR
Aggregate routing queries with the same
origin
.TP
\fB\-\-routing\-threads\fR INT
The number of parallel execution threads
used for routing
.TP
\fB\-\-restriction\-params\fR STR[]
Comma separated list of param keys to
compare for additional restrictions
.TP
\fB\-\-weights\fR.minor\-penalty FLOAT
Apply the given time penalty when computing
routing costs for minor\-link internal lanes
.TP
\fB\-\-max\-edges\-factor\fR FLOAT
Routes are cut off when the route edges to
net edges ratio is larger than FLOAT
.TP
\fB\-T\fR, \fB\-\-turn\-defaults\fR STR[]
Use STR[] as default turn definition
.TP
\fB\-\-sink\-edges\fR STR[]
Use STR[] as list of sink edges
.TP
\fB\-A\fR, \fB\-\-accept\-all\-destinations\fR
Whether all edges are allowed as sink edges
.TP
\fB\-i\fR, \fB\-\-ignore\-vclasses\fR
Ignore road restrictions based on vehicle
class
.TP
\fB\-\-allow\-loops\fR
Allow to re\-use a road
.TP
\fB\-S\fR, \fB\-\-sources\-are\-sinks\fR
Use all source edges as sink edges.
.TP
\fB\-D\fR, \fB\-\-discount\-sources\fR
Subtract upstream flow when inserting a new
flow. When option \fB\-\-sources\-are\-sinks\fR is
set, the upstream flow is limited to the
value of the source flow and the remaining
part terminates.
.SS "Defaults Options:"
.TP
\fB\-\-departlane\fR STR
Assigns a default depart lane
.TP
\fB\-\-departpos\fR STR
Assigns a default depart position
.TP
\fB\-\-departspeed\fR STR
Assigns a default depart speed
.TP
\fB\-\-arrivallane\fR STR
Assigns a default arrival lane
.TP
\fB\-\-arrivalpos\fR STR
Assigns a default arrival position
.TP
\fB\-\-arrivalspeed\fR STR
Assigns a default arrival speed
.TP
\fB\-\-defaults\-override\fR
Defaults will override given values
.SS "Time Options:"
.TP
\fB\-b\fR, \fB\-\-begin\fR TIME
Defines the begin time;
Previous trips will be discarded
.TP
\fB\-e\fR, \fB\-\-end\fR TIME
Defines the end time;
Later trips will be discarded;
Defaults to the maximum time that SUMO can
represent
.SS "Report Options:"
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Switches to verbose output
.TP
\fB\-\-print\-options\fR
Prints option values before processing
.TP
\-?, \fB\-\-help\fR
Prints this screen or selected topics
.TP
\fB\-V\fR, \fB\-\-version\fR
Prints the current version
.TP
\fB\-X\fR, \fB\-\-xml\-validation\fR STR
Set schema validation scheme of XML inputs
("never", "local", "auto" or "always")
.TP
\fB\-\-xml\-validation\fR.net STR
Set schema validation scheme of SUMO network
inputs ("never", "local", "auto" or
"always")
.TP
\fB\-\-xml\-validation\fR.routes STR
Set schema validation scheme of SUMO route
inputs ("never", "local", "auto" or
"always")
.TP
\fB\-W\fR, \fB\-\-no\-warnings\fR
Disables output of warnings
.TP
\fB\-\-aggregate\-warnings\fR INT
Aggregate warnings of the same type whenever
more than INT occur
.TP
\fB\-l\fR, \fB\-\-log\fR FILE
Writes all messages to FILE (implies
verbose)
.TP
\fB\-\-message\-log\fR FILE
Writes all non\-error messages to FILE
(implies verbose)
.TP
\fB\-\-error\-log\fR FILE
Writes all warnings and errors to FILE
.TP
\fB\-\-language\fR STR
Language to use in messages
.TP
\fB\-\-ignore\-errors\fR
Continue if a route could not be build
.TP
\fB\-\-stats\-period\fR INT
Defines how often statistics shall be
printed
.TP
\fB\-\-no\-step\-log\fR
Disable console output of route parsing step
.SS "Random Number Options:"
.TP
\fB\-\-random\fR
Initialises the random number generator with
the current system time
.TP
\fB\-\-seed\fR INT
Initialises the random number generator with
the given value
.SH EXAMPLES
.IP
jtrrouter \-c <CONFIGURATION>
.IP
run with routing options defined in file
.SH "REPORTING BUGS"
Report bugs at <https://github.com/eclipse/sumo/issues>.
.br
Get in contact via <sumo@dlr.de>.
.IP
.br
Build features: Linux\-6.1.0\-18\-amd64 x86_64 GNU 13.2.0 None FMI Proj GUI Intl SWIG GDAL FFmpeg OSG GL2PS Eigen
.br
Copyright (C) 2001\-2023 German Aerospace Center (DLR) and others; https://sumo.dlr.de
.PP
.br
Eclipse SUMO jtrrouter Version 1.18.0 is part of SUMO.
.br
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
.br
This program may also be made available under the following Secondary
.br
Licenses when the conditions for such availability set forth in the Eclipse
.br
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
.br
SPDX\-License\-Identifier: EPL\-2.0 OR GPL\-2.0\-or\-later