sdk

package module
Version: v0.20.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 7, 2022 License: Apache-2.0 Imports: 3 Imported by: 0

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

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

Directories

Path Synopsis
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
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.
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.
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.
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
run
Package run provides tools for running solvers.
Package run provides tools for running solvers.
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.
Package store provides a modeling kit for decision automation problems.
Package store provides a modeling kit for decision automation problems.
Package templates contains variables holding embded template files.
Package templates contains variables holding embded template files.
cloud-routing
package main holds the implementation of the cloud-routing template.
package main holds the implementation of the cloud-routing template.
knapsack
package main holds the implementation of the knapsack template.
package main holds the implementation of the knapsack template.
mip-incentive-allocation
package main holds the implementation of the mip incentive allocation template.
package main holds the implementation of the mip incentive allocation template.
mip-knapsack
package main holds the implementation of the mip-knapsack template.
package main holds the implementation of the mip-knapsack template.
mip-meal-allocation
package main holds the implementation of the mip-meal-allocation template.
package main holds the implementation of the mip-meal-allocation template.
new-app
package main holds the implementation of the new-app template.
package main holds the implementation of the new-app template.
pager-duty
package main holds the implementation of the pager-duty template.
package main holds the implementation of the pager-duty template.
routing
package main holds the implementation of the routing template.
package main holds the implementation of the routing template.
shift-scheduling
package main holds the implementation of the shift-scheduling template.
package main holds the implementation of the shift-scheduling template.
sudoku
Package sudoku holds the implementation of the sudoku template.
Package sudoku holds the implementation of the sudoku template.

Jump to

Keyboard shortcuts

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