Skip to content

Usage

Jump to bottom
Julien Coupey edited this page Mar 4, 2021 · 24 revisions

API documentation

Documentation for:

Input and output

The problem can be read from standard input:

vroom INPUT

or from a file, using the -i flag.

vroom -i myfile

The solution is written to standard output unless a file name is specified with -o.

Use with OSRM

VROOM will default to using OSRM for all routing-related matters, such as computing the cost matrix and getting the detailed route geometry once the solution is computed. See how to build your own OSRM instance.

If the OSRM server is running on the same machine on the default port (5000), all is fine. Otherwise the -a and -p options are required to set the corresponding address and port for the server (see complete usage and options list below).

Important: if you plan to use a number of locations that overpass the default maximum in OSRM table and route plugins, you have to set the --max-table-size and --max-viaroute-size options accordingly for osrm-routed.

User-defined cost matrix

VROOM can solve user-defined problems where the cost matrix comes from any other source than OSRM and is explicitly provided.

Complete usage and options list for v1.9.0

$ vroom -h
VROOM Copyright (C) 2015-2021, Julien Coupey
Version: 1.9.0
Usage:
	vroom [OPTION]... "INPUT"
	vroom [OPTION]... -i FILE
Options:
	-a PROFILE:HOST (=car:0.0.0.0)	 routing server
	-c,				 choose ETA for custom routes and report violations
	-g,				 add detailed route geometry and indicators
	-i FILE,			 read input from FILE rather than from stdin
	-o OUTPUT,			 output file name
	-p PROFILE:PORT (=car:5000),	 routing server port
	-r ROUTER (=osrm),		 osrm, libosrm or ors
	-t THREADS (=4),		 number of threads to use
	-x EXPLORE (=5),		 exploration level to use (0..5)
Clone this wiki locally