1- # Complex Route Optimization in Milliseconds
1+ # Vehicle Routing Open-source Optimization Machine
22
33_ Good solutions, fast._
44
55---
66
77## About
88
9- Vroom is an open-source route optimization engine written in C++20
10- that solves complex [ vehicle routing
9+ VROOM is an open-source optimization engine written in C++20 that aim
10+ at providing good solutions to various real-life [ vehicle routing
1111problems] ( https://en.wikipedia.org/wiki/Vehicle_routing_problem ) (VRP)
12- in milliseconds.
13-
14- The project is maintained by [ Verso] ( https://verso-optim.com ) . If you
15- want to get started as quickly as possible with route optimization,
16- you want white-glove support to increase the ROI from your
17- optimization project and/or you need access to the best possible data
18- for even more accurate route timing, you should use the [ Vroom Premium
19- API] ( https://verso-optim.com/api/ ) .
20-
21- ## Why use Vroom?
22-
23- Vroom is ideally suited to situations in which route optimization has
24- to be done quickly, both to react to changes and new requests and to
25- iterate on your routes to find the solution that works best for all
26- stakeholders.
27-
28- Vroom doesn't replace domain expertise. It allows fleet managers and
29- business owners to apply their domain knowledge and understanding of
30- the company culture to larger, more complex optimization problems than
31- they could manage manually.
32-
33- The open source project is ideal for companies who want to control
34- their own infrastructure, have the technical expertise to do so and
35- can manage their own data integration. If you would rather not manage
36- your own infrastructure, if you want access to expertise around route
37- optimization or if you want more accurate ETA relying on enhanced
38- speed estimates, consider using the [ Vroom Premium
39- API] ( https://verso-optim.com/api/ ) .
12+ within a small computing time.
13+
14+ The project has been initiated by [ Verso] ( https://verso-optim.com/ ) to
15+ power its [ route optimization
16+ API] ( https://blog.verso-optim.com/category/route-optimization/api/ ) .
4017
4118## Supported problem types
4219
43- Vroom solves several well-known types of vehicle routing problems
20+ VROOM can solve several well-known types of vehicle routing problems
4421(VRP).
4522
4623- TSP (travelling salesman problem)
@@ -49,13 +26,11 @@ Vroom solves several well-known types of vehicle routing problems
4926- MDHVRPTW (multi-depot heterogeneous vehicle VRPTW)
5027- PDPTW (pickup-and-delivery problem with TW)
5128
52- Vroom solves all of the above routing problems at the same time — and
53- delivers the optimized route in milliseconds, even when complex
54- variables are involved.
29+ VROOM can also solve any mix of the above problem types.
5530
56- ## How it works
31+ ## Features
5732
58- Vroom models a VRP with a description of resources (` vehicles ` ),
33+ VROOM models a VRP with a description of resources (` vehicles ` ),
5934single-location pickup and/or delivery tasks (` jobs ` ) and
6035pickup-and-delivery tasks that should happen within the same route
6136(` shipments ` ).
@@ -80,14 +55,14 @@ pickup-and-delivery tasks that should happen within the same route
8055
8156## Supported routing engines
8257
83- Vroom works out-of-the-box on top of several open-source routing
58+ VROOM works out-of-the-box on top of several open-source routing
8459engines.
8560
8661- [ OSRM] ( http://project-osrm.org/ )
8762- [ Openrouteservice] ( https://openrouteservice.org/ )
8863- [ Valhalla] ( https://github.com/valhalla/valhalla )
8964
90- Vroom can also use a custom cost matrix computed from any other
65+ VROOM can also use a custom cost matrix computed from any other
9166source.
9267
9368## Getting started
@@ -97,54 +72,54 @@ source.
9772- The [ demo frontend] ( http://map.vroom-project.org/ ) provides a simple
9873user interface for quick tests.
9974- The [ demo
100- server] ( https://github.com/Vroom -Project/vroom/wiki/Demo-server ) makes
75+ server] ( https://github.com/VROOM -Project/vroom/wiki/Demo-server ) makes
10176it easy to send sample optimization requests for testing purposes.
10277
103- ### Setup your own Vroom stack
78+ ### Setup your own VROOM stack
10479
10580#### Solving engine
10681
10782Several options are available to get ` vroom ` running on command-line.
10883
109841 . Build from source following [ the wiki
110- instructions] ( https://github.com/Vroom -Project/vroom/wiki/Building ) .
85+ instructions] ( https://github.com/VROOM -Project/vroom/wiki/Building ) .
111862 . Use
112- [ ` vroom-docker ` ] ( https://github.com/Vroom -Project/vroom-docker ) .
87+ [ ` vroom-docker ` ] ( https://github.com/VROOM -Project/vroom-docker ) .
11388
11489### Command-line usage
11590
11691Refer to [ this wiki
117- page] ( https://github.com/Vroom -Project/vroom/wiki/Usage )
92+ page] ( https://github.com/VROOM -Project/vroom/wiki/Usage )
11893
11994#### Http wrapper
12095
121- [ ` vroom-express ` ] ( https://github.com/Vroom -Project/vroom-express ) is a
96+ [ ` vroom-express ` ] ( https://github.com/VROOM -Project/vroom-express ) is a
12297simple wrapper to use ` vroom ` with http requests. It's already bundled
12398in the ` vroom-docker ` setup.
12499
125100#### Using libvroom from C++
126101
127102The project can also used as a library from any C++ project, refer to
128103[ this wiki
129- page] ( https://github.com/Vroom -Project/vroom/wiki/Using-libvroom ) .
104+ page] ( https://github.com/VROOM -Project/vroom/wiki/Using-libvroom ) .
130105
131106## Tests
132107
133108### CI builds
134109
135- [ ![ vroom] ( https://github.com/Vroom -Project/vroom/actions/workflows/vroom.yml/badge.svg )] ( https://github.com/Vroom -Project/vroom/actions/workflows/vroom.yml )
110+ [ ![ vroom] ( https://github.com/VROOM -Project/vroom/actions/workflows/vroom.yml/badge.svg )] ( https://github.com/VROOM -Project/vroom/actions/workflows/vroom.yml )
136111
137- [ ![ vroom + libosrm] ( https://github.com/Vroom -Project/vroom/actions/workflows/vroom_libosrm.yml/badge.svg?branch=master )] ( https://github.com/Vroom -Project/vroom/actions/workflows/vroom_libosrm.yml )
112+ [ ![ vroom + libosrm] ( https://github.com/VROOM -Project/vroom/actions/workflows/vroom_libosrm.yml/badge.svg?branch=master )] ( https://github.com/VROOM -Project/vroom/actions/workflows/vroom_libosrm.yml )
138113
139- [ Github Actions] ( https://github.com/Vroom -Project/vroom/actions ) are
114+ [ Github Actions] ( https://github.com/VROOM -Project/vroom/actions ) are
140115used to check the build across various compilers and settings.
141116
142117### Functional tests
143118
144119Several sets of instances are used.
145120
1461211 . Benchmark instances from papers (see [ wiki page with
147- results] ( https://github.com/Vroom -Project/vroom/wiki/Benchmarks ) ).
122+ results] ( https://github.com/VROOM -Project/vroom/wiki/Benchmarks ) ).
1481232 . Custom random instances generated to target typical use-cases and
149124constraints settings.
1501253 . Real-life instances.
@@ -156,11 +131,11 @@ solution quality and computing times.
156131
157132## Reference in publications
158133
159- To cite Vroom in publications, please use:
134+ To cite VROOM in publications, please use:
160135
161136``` bibtex
162137@manual{vroom_v1.14,
163- title = {{Vroom v1.14, Vehicle Routing Open-source Optimization Machine}},
138+ title = {{VROOM v1.14, Vehicle Routing Open-source Optimization Machine}},
164139 author = {Coupey, Julien and Nicod, Jean-Marc and Varnier, Christophe},
165140 year = 2024,
166141 organization = {Verso (\url{https://verso-optim.com/})},
0 commit comments