Vehicle routing open-source optimization machine (VROOM)

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jonathf from gravatar.com jonathf

Unverified details

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: BSD License (BSD 2-Clause License)

Author: Jonathan Feinberg

Requires: Python >=3.7

Classifiers

Project description

gh_action codecov pypi

Good solution, fast… in Python.

Pyvroom is an Python wrapper to the excellent VROOM optimization engine for solving vehicle routing problems.

The library aims to solve several well-known types of vehicle routing problems, including:

  • Travelling salesman.

  • Capacitated vehicle routing.

  • Routing with time windows.

  • Multi-depot heterogeneous vehicle.

  • Pickup-and-delivery.

VROOM can also solve any mix of the above problem types.

Installation

Pyvroom currently makes binaries for on MacOS and Linux (Windows is WIP).

Installation should be as simple as:

pip install pyvroom

Building from source

Building the source distributions on another OS requires:

  • the ./build-requirements.txt Python dependencies

  • asio headers installed

  • openssl & crypto libraries & headers installed

Optionally the C++ dependencies can be installed with conan:

conan install --build=openssl --install-folder conan_build .

Basic usage

>>> import vroom

>>> problem_instance = vroom.Input()

>>> problem_instance.set_durations_matrix(
...     profile="car",
...     matrix_input=[[0, 2104, 197, 1299],
...                   [2103, 0, 2255, 3152],
...                   [197, 2256, 0, 1102],
...                   [1299, 3153, 1102, 0]],
... )

>>> problem_instance.add_vehicle([vroom.Vehicle(47, start=0, end=0),
...                               vroom.Vehicle(48, start=2, end=2)])

>>> problem_instance.add_job([vroom.Job(1414, location=0),
...                           vroom.Job(1515, location=1),
...                           vroom.Job(1616, location=2),
...                           vroom.Job(1717, location=3)])

>>> solution = problem_instance.solve(exploration_level=5, nb_threads=4)

>>> solution.summary.cost
6411

>>> solution.routes.columns
Index(['vehicle_id', 'type', 'arrival', 'duration', 'setup', 'service',
       'waiting_time', 'location_index', 'id', 'description'],
      dtype='object')

>>> solution.routes[["vehicle_id", "type", "arrival", "location_index", "id"]]
   vehicle_id   type  arrival  location_index    id
0          47  start        0               0  <NA>
1          47    job     2104               1  1515
2          47    job     4207               0  1414
3          47    end     4207               0  <NA>
4          48  start        0               2  <NA>
5          48    job     1102               3  1717
6          48    job     2204               2  1616
7          48    end     2204               2  <NA>

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jonathf from gravatar.com jonathf

Unverified details

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: BSD License (BSD 2-Clause License)

Author: Jonathan Feinberg

Requires: Python >=3.7

Classifiers

Release history Release notifications | RSS feed

1.13.5.dev1 pre-release

1.13.5.dev0 pre-release

1.13.4

1.13.4.dev5 pre-release

1.13.4.dev1 pre-release

1.13.4.dev0 pre-release

1.13.3

1.13.3.dev6 pre-release

1.13.3.dev4 pre-release

1.13.2

1.13.1

1.13.0

0.0.16

0.0.15

0.0.14

0.0.13

This version

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvroom-0.0.12.tar.gz (32.2 kB view hashes)

Uploaded Source

Built Distributions

pyvroom-0.0.12-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.0 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

pyvroom-0.0.12-cp310-cp310-macosx_10_14_x86_64.whl (2.2 MB view hashes)

Uploaded CPython 3.10 macOS 10.14+ x86-64

pyvroom-0.0.12-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.0 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

pyvroom-0.0.12-cp39-cp39-macosx_10_14_x86_64.whl (2.2 MB view hashes)

Uploaded CPython 3.9 macOS 10.14+ x86-64

pyvroom-0.0.12-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.0 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

pyvroom-0.0.12-cp38-cp38-macosx_10_14_x86_64.whl (2.2 MB view hashes)

Uploaded CPython 3.8 macOS 10.14+ x86-64

pyvroom-0.0.12-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.0 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

pyvroom-0.0.12-cp37-cp37m-macosx_10_14_x86_64.whl (2.2 MB view hashes)

Uploaded CPython 3.7m macOS 10.14+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page