README.md

Toolbox Python API

This python script can be used as library to automatically invoke the ProvideQ API. You can use this to solve any kind of problem with a set of pre-defined solvers.
For more information how to use the API, see the ProvideQ wiki.

Example

api = ProvideQApi("https://api.provideq.kit.edu")

# Solvers for subroutines
solver_per_type = {
    "cluster-vrp": lambda: "edu.kit.provideq.toolbox.vrp.clusterer.TwoPhaseClusterer",
    "tsp": lambda: "edu.kit.provideq.toolbox.tsp.solvers.LkhTspSolver"
}

# Set settings for per solver
settings_per_solver_id = {
    "edu.kit.provideq.toolbox.vrp.clusterer.KmeansClusterer": lambda: [
        {
            "name": "Cluster Number",
            "type": "INTEGER",
            "required": False,
            "description": "",
            "min": 1,
            "max": 1000,
            "value": 3,
        }
    ],
}

api.solve("vrp", "<some_vrp_input>", "edu.kit.provideq.toolbox.vrp.solvers.ClusterAndSolveVrpSolver", solver_per_type, settings_per_solver_id)