sdk

package module

v0.32.0 Latest Latest Go to latest Published: Oct 5, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/nextmv-io/sdk

Links

Open Source Insights

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.
mip: Mixed-Integer Programming API with various solvers.
templates: ready-to-go applications for solving various types of decision automation problems. Designed to work with the Nextmv CLI.
inputs: .json inputs for working with the Nextmv routing app. Designed to work with the Nextmv CLI.

Please visit the official Nextmv docs for comprehensive information.

Installation

Nextmv's SDK is meant to be used in Go projects. To download please run:

go get github.com/nextmv-io/sdk

Documentation ¶

Overview ¶

Package sdk provides API declarations of the Nextmv software development kit. Please visit the associated packages (directories) for complete documentation.

Index ¶

Variables

Constants ¶

This section is empty.

Variables ¶

View Source

var VERSION = getVersion()

VERSION of Nextmv SDK.

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

version.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
alns Package alns defines interfaces for Adaptive Large Neighborhood Search.	Package alns defines interfaces for Adaptive Large Neighborhood Search.
cluster
kmeans Package kmeans provides a general interface for solving kmeans clustering problems.	Package kmeans provides a general interface for solving kmeans clustering problems.
connect Package connect provides a Connector which allows to connect method definition with their implementations in plugins	Package connect provides a Connector which allows to connect method definition with their implementations in plugins
dataframe Package dataframe provides a general interface for managing tabular data that support filtering, aggregation and data manipulation.	Package dataframe provides a general interface for managing tabular data that support filtering, aggregation and data manipulation.
inputs Package inputs contains variables holding embed example input files for use with the cloud routing API.	Package inputs contains variables holding embed example input files for use with the cloud routing API.
measure 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
mip Package mip provides a general interface for solving mixed integer linear optimization problems using a variety of back-end solvers.	Package mip provides a general interface for solving mixed integer linear optimization problems using a variety of back-end solvers.
model Package model provides modeling components, such as domains and ranges.	Package model provides modeling components, such as domains and ranges.
nextroute Package nextroute is a package	Package nextroute is a package
check Package check provides a plugin that allows you check models and solutions.	Package check provides a plugin that allows you check models and solutions.
common Package common contains common types and functions.	Package common contains common types and functions.
factory Package factory is a package containing factory functions for creating next-route models.	Package factory is a package containing factory functions for creating next-route models.
schema Package schema provides the input and output schema for nextroute.	Package schema provides the input and output schema for nextroute.
plugin Package plugin provides functions for connecting plugins built from a private source.	Package plugin provides functions for connecting plugins built from a private source.
route Package route provides vehicle routing functionalities.	Package route provides vehicle routing functionalities.
google module
here module
osrm module
routingkit module
run 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.
validate Package validate contains Validator implementations.	Package validate contains Validator implementations.
store Package store provides a modeling kit for decision automation problems.	Package store provides a modeling kit for decision automation problems.
templates Package templates contains variables holding embedded template files.	Package templates contains variables holding embedded template files.
legacy Package legacy contains variables holding embedded legacy template files.	Package legacy contains variables holding embedded legacy template files.
legacy/cloud-routing command package main holds the implementation of the cloud-routing template.	package main holds the implementation of the cloud-routing template.
legacy/cluster command package main holds the implementation of the cluster template.	package main holds the implementation of the cluster template.
legacy/cluster-tsp command package main holds the implementation of the routing template.	package main holds the implementation of the routing template.
legacy/demo-routing command package main holds the implementation of the cloud-routing template.	package main holds the implementation of the cloud-routing template.
legacy/knapsack command package main holds the implementation of the knapsack template.	package main holds the implementation of the knapsack template.
legacy/measure-matrix command package main holds the implementation of the measure generation.	package main holds the implementation of the measure generation.
legacy/mip-incentive-allocation command package main holds the implementation of the mip incentive allocation template.	package main holds the implementation of the mip incentive allocation template.
legacy/mip-knapsack command package main holds the implementation of the mip-knapsack template.	package main holds the implementation of the mip-knapsack template.
legacy/mip-meal-allocation command package main holds the implementation of the mip-meal-allocation template.	package main holds the implementation of the mip-meal-allocation template.
legacy/new-app command package main holds the implementation of the new-app template.	package main holds the implementation of the new-app template.
legacy/pager-duty command package main holds the implementation of the pager-duty template.	package main holds the implementation of the pager-duty template.
legacy/routing command package main holds the implementation of the routing template.	package main holds the implementation of the routing template.
legacy/routing-informs command package main holds the implementation of the cloud-routing template.	package main holds the implementation of the cloud-routing template.
legacy/routing-legacy command package main holds the implementation of the nextroute template.	package main holds the implementation of the nextroute template.
legacy/routing-matrix-input command package main holds the implementation of the routing template.	package main holds the implementation of the routing template.
legacy/sudoku command Package sudoku holds the implementation of the sudoku template.	Package sudoku holds the implementation of the sudoku template.
legacy/time-dependent-measure command package main holds the implementation of the routing template.	package main holds the implementation of the routing template.
legacy/unique-matrix-measure command package main holds the implementation of the routing template.	package main holds the implementation of the routing template.
mip command package main holds the implementation of the mip-knapsack template.	package main holds the implementation of the mip-knapsack template.
nextroute command package main holds the implementation of the nextroute template.	package main holds the implementation of the nextroute template.
shift-scheduling command package main holds the implementation of the shift scheduling template.	package main holds the implementation of the shift scheduling template.