solverstack-route

[Under Development] NOTE: API is not finalized and will change.

TODO: add current and future specs/features.

Service for route module.

MVP

/api/<version>/

Main Procedure

NOTE: origin initially will just be a single dictionary. Eventually lists will be accepted.

• Endpoint: /route
• Methods: POST
• Request Syntax:

{
  "stack_id": <int>,
  "origin": {
    "id": <int>,
    "latitude": <float>,
    "longitude": <float>
  },
  "demand": [
    {
      "id": <int>,
      "latitude": <float>,
      "longitude": <float>,
      "quantity": <int>
    }
  ],
  "unit": <str>,
  "vehicle_max_capacity_units": <int>,

  // **OPTIONAL**
  "vehicle_definitions": [
    <int>
  ]
}

vehicle_max_capacity_units should be the same unit of measure as unit.

vehicle_definitions (optional) represent both the number of vehicles and their max capacities.

"vehicle_definitions": [26, 26, 26, 26]

• output data:

{
  "stack_id": <int>,
  "origin": [{
    "id": <int>,
    "latitude": <float>,
    "longitude": <float>
  }],
  "demand": [{
    "id": <int>,
    "latitude": <float>,
    "longitude": <float>,
    "quantity": <int>
  }],
  "routes": [{
      "id": <int>,
      "cluster_id": <int>,
      "vehicle_id": <int>,
      "stop_num": <int>
  }],
  "unit": <str>,
  "vehicle_max_capacity_units": <int>
}

Usage

• Clone the repository using git clone or download it as a .zip and extract it.
• cd solverstack-route or open a terminal in the solverstack-route directory.
• OPTIONAL Create a virtual environment using python venv. This is preferred to keep the packages for this project separate.
• Install required packages using python -m pip install -r requirements.txt
• Run the flask server using python manage.py runserver
• Voila!

Testing

• You can run the tests using the pytest module
• Install dependencies using python -m pip install -r requirements-dev.txt
• Run python -m pytest

(Optional) Using Docker container for testing

You can use a Docker container for running the tests by using the provided Dockerfile.test

• Build the Docker image using docker build -f Dockerfile.test . -t andromia:solverstack-route-test.
• Run the image using docker run andromia:solverstack-route-test

TODO

• replace dict[key][key]... with pandas wrappers.

Other

See cvrp-poc for demo application.