README
¶
Nextmv's Software Development Kit
Nextmv's SDK is a collection of Go APIs for solving decision automation problems. Please find the following packages:
- store: an all-purpose modeling kit for decision automation problems, serving as the core of Nextmv's SDK.
- route: a modeling kit for vehicle routing problems.
- run: convenient runners that read an input, run a solver and write an output.
- model: modeling components such as integer domains and ranges.
Please visit the official Go Package Docs for documentation and testable examples.
Get started
Please visit the tour of SDK to get started with data store modeling.
Installation
Nextmv's SDK is meant to be used in Go projects. To download please run:
go get github.com/nextmv-io/sdk
Usage
To run a decision automation problem Nextmv's SDK requires specific plugins.
Please contact support for details on installing plugins. They are
not required to build.
Documentation
¶
Overview ¶
Package sdk provides API declarations of the Nextmv software development kit. Please visit the associated packages (directories) for complete documentation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var VERSION string
VERSION of Nextmv SDK.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
measure
|
|
|
google
module
|
|
|
here
module
|
|
|
osrm
module
|
|
|
routingkit
module
|
|
|
Package model provides modeling components, such as domains and ranges.
|
Package model provides modeling components, such as domains and ranges. |
|
Package plugin provides functions for connecting plugins built from a private source.
|
Package plugin provides functions for connecting plugins built from a private source. |
|
Package route provides vehicle routing functionalities.
|
Package route provides vehicle routing functionalities. |
|
google
module
|
|
|
here
module
|
|
|
osrm
module
|
|
|
routingkit
module
|
|
|
Package run provides tools for running solvers.
|
Package run provides tools for running solvers. |
|
Package store provides a modeling kit for decision automation problems.
|
Package store provides a modeling kit for decision automation problems. |