router engine is deprecated. To read about our current
vehicle routing engine documentation start reading here.
This how-to guide assumes you already completed the steps described in the 5-minute getting started experience. To test that the Nextmv CLI is correctly configured, you can optionally run the following command on your terminal. It will get some files that are necessary to work with the Nextmv Platform. You can see the expected output as well.
The Nextmv Software Development Kit (SDK) lets you automate any operational decision in a way that looks and feels like writing other code. It provides the guardrails to turn your data into automated decisions and test and deploy them into production environments.
This guide will walk you through our
routing template. To get the template, simply run the following command.
You can check that all files are available in the newly created
routing folder. Running the
tree command, you should see the file structure.
README.mdgives a short introduction to the routing problem and shows you how to run the template.
go.sumdefine a Go module and are used to manage dependencies, including the Nextmv SDK.
input.jsondescribes the input data for a specific routing problem that is solved by the template.
licensecontains the Apache License 2.0 under which we distribute this template.
main.gocontains the actual code of the Nextmv routing app.
routing.code-workspacefile should be used to open the template in Visual Studio Code. It is pre-configured for you so that you can run and debug the template without any further steps.
Now you can run the template with the Nextmv CLI, reading from the
input.json file and writing to an
output.json file. The following command shows you how to specify solver limits as well. You should obtain an output similar to the one shown.
Note that transient fields like timestamps, duration, versions, etc. are represented with dummy values due to their dynamic nature. I.e., every time the input is run or the version is bumped, these fields will have a different value.
Now we will show you, step by step, what the code inside the
The first part of the
main.go defines a package name, imports packages that are needed by the code below and a
main function which is the starting point for the app. In the
main function the
Run function from the Nextmv
run package is being called. This function executes a solver which is passed in the form of the
solver function further down in the file.
But before we look into the
solver function, we will examine the different structs that represent the needed data used by the app.
input struct lists the two required input fields,
Vehicles, as well as a list of available options.
Stops describes the list of locations to visit, and
Vehicles is an array of vehicle IDs. To learn about the additional options and how they're used, check out the how-to guide on router engine options.
solver function is where the model is defined. The function's signature adheres to the
run.Run function we saw earlier already.
When you first ran the template you passed in the parameter
-runner.input.path followed by the path to an input file. This file is automatically parsed and converted to our
input struct. Other option arguments are also interpreted automatically passed to the solver as an
Similar to the options you passed in when you ran the template,
-diagram.expansion.limit you can also set these values directly in your
main.go if you'd prefer not to pass them from the command line.
Finally, we return a
solver for our
router passing in options that were given at the very beginning by the calling function. This solver is then executed by the
run.Run function from the beginning.