# 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.
# Packages
Package flatmap contains functions to flatten and unflatten maps:
- [Do] flattens a nested map into a flat map.
Package golden holds tools for testing documentation code.
Package measure contains cost measures based on indices or points.
Package run provides tools for running solvers.