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:
- run: convenient runners that read an input, run a solver and write an output.
- measure: measures for various distances between locations.
- golden: tools for running tests with golden files.
- flatmap: functionality for flattening and unflattening maps.
Please visit the official Nextmv docs for comprehensive information.
Versioning
We try our best to version our software thoughtfully and only break APIs and behaviors when we have a good reason to.
- Minor (
v1.^.0) tags: new features, might be breaking. - Patch (
v1.0.^) tags: bug fixes.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package flatmap contains functions to flatten and unflatten maps:
|
Package flatmap contains functions to flatten and unflatten maps: |
|
Package golden holds tools for testing documentation code.
|
Package golden holds tools for testing documentation code. |
|
Package measure contains cost measures based on indices or points.
|
Package measure contains cost measures based on indices or points. |
|
google
Module
|
|
|
here
Module
|
|
|
osrm
Module
|
|
|
routingkit
Module
|
|
|
route
|
|
|
google
Module
|
|
|
here
Module
|
|
|
osrm
Module
|
|
|
routingkit
Module
|
|
|
Package run provides tools for running solvers.
|
Package run provides tools for running solvers. |
|
cli
Package cli provides additional features for CLIRunner.
|
Package cli provides additional features for CLIRunner. |
|
decode
Package decode provides decoders for output of a runner.
|
Package decode provides decoders for output of a runner. |
|
encode
Package encode provides encoders for input of a runner.
|
Package encode provides encoders for input of a runner. |
|
http
Package http provides additional features for HTTPRunner.
|
Package http provides additional features for HTTPRunner. |
|
schema
Package schema provides the schema for the output.
|
Package schema provides the schema for the output. |
|
statistics
Package statistics provides the schema for the statistics section of the output.
|
Package statistics provides the schema for the statistics section of the output. |
|
tests/http/async
package main holds the implementation of a simple runner example.
|
package main holds the implementation of a simple runner example. |
|
tests/http/error_log
package main holds the implementation of a simple runner example.
|
package main holds the implementation of a simple runner example. |
|
tests/http/sync
package main holds the implementation of a simple runner example.
|
package main holds the implementation of a simple runner example. |
|
tests/http/too_many_requests
package main holds the implementation of a simple runner example.
|
package main holds the implementation of a simple runner example. |
|
tests/simple
package main holds the implementation of a simple runner example.
|
package main holds the implementation of a simple runner example. |
|
validate
Package validate contains Validator implementations.
|
Package validate contains Validator implementations. |
Click to show internal directories.
Click to hide internal directories.