node_or_tools

Native module for the or-tools TSP / VRP solvers

Usage no npm install needed!

<script type="module">
  import nodeOrTools from 'https://cdn.skypack.dev/node_or_tools';
</script>

README

node-or-tools

Build Status

NodeJS bindings for or-tools Travelling Salesman Problem (TSP) and Vehicle Routing Problem (VRP) solvers.

See API.md for documentation.

Solving TSP and VRP problems always starts out with having a m x m cost matrix for all pairwise routes between all locations. We recommend using the Mapbox Directions Matrix service when optimizing travel times.

Example

Quick Start

npm install node_or_tools

var ortools = require('node_or_tools')

var VRP = new ortools.VRP(solverOpts);

VRP.Solve(searchOpts, function (err, solution) {
  // ..
});

See API.md for interface documentation and the example for a small self-contained example.

We ship pre-built native binaries (for Node.js LTS 4 and 6 on Linux and macOS). You will need a compatible C++ stdlib, see below if you encounter issues. Building from source is supported via the --build-from-source flag.

Ubuntu 16.04

You're fine. The system's stdlib is recent enough.

Ubuntu 14.04

apt install software-properties-common
add-apt-repository ppa:ubuntu-toolchain-r/test
apt update
apt install libstdc++-5-dev

Tests

npm test

Building - Undefined Symbols

If your C++ compiler and stdlib are quite recent they will default to a new ABI. Mason packages are still built against an old ABI. If you see undefined symbols errors force the stdlib to use the old ABI by setting:

export CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=0"

and re-build the project.

Releases

  • Push commit with [publish binary] on master
  • Wait for Travis to build and publish binaries, check the AWS bucket if in doubt
  • Tag the release git tag vx.y.z -a on master, git push origin vx.y.z
  • Then npm login, npm publish to npm
  • Make Github Release for tag

References

Routing Interfaces

More or-tools

Tests

Node bindings

License

Copyright © 2017 Mapbox

Distributed under the MIT License (MIT).