bcgov / bcgov/ols-devkit

Create a Route List Editor called Arly

Open
#162 0 comments 0 reactions 1 assignee Claimed by @mraross View on GitHub
medium priority new app P1 Route Planner Validator rpng
Dominant language
No language data
Stars
7
Forks
6
Avg merge
1d 16h
Merged PRs (30d)
1

Description

Create a _**Route List Editor**_ called Arly that let's you load a file containing a list of routes , edit them, and export them to a file. The route list editor should support current routing functionality in the demo app plus saving the addresses of route waypoints.

BC Mail Plus needs Arly to define delivery route and help new delivery staff get familiar with existing delivery routes.
BC Emergency Health Services needs Arly to define patient transfer routes.
DataBC Location Services needs Arly to help manage test routes.
OnRoute needs Arly to manage OnRoute benchmark routes for the Route List Validator.

The Route List Editor will be a Progressive Web App that allows you to create and edit a list of routes in your browser. The RLE (pronounced Arly) is needed in OnRoute to allow permitting staff and others with local knowledge of the road network to define benchmark routes that will be used by Location Services in system and acceptance testing of the new Route Planner. Location Services will also use RLE to create a list of test routes that test individual features of the route planner. This could result in a route list file contains tens of thousands of routes.

The RLE will be able to read and write a route list file in JSON format so no database is required and no security is necessary (e.g., Bring Your Own Routes). The RLE will be hosted by Location Services and available to all.

The Route List file data schema has to have sufficient information to make requests to the OLS-Route Planner. That means all Directions resource parameters must be supported.

The Brython Router Probe is a test framework built in Python by Brian and will need to be enhanced to read route list files produced by RLE. The route definition in the BRP would be a good starting point for the Route List file data schema.

The Route List Editor is also needed by BC Mail, one of our current router prospects, for training their drivers on new routes and for developing better routes. BC Mail delivers in-house government mail across the province. We wouldn’t have got funding for OnRoute without BC Mail as a prospect because it showed we are building a route planner for all of government, not just MoTi.

RLE should be useful to any government agency that has logistical problems such as Emergency Management BC, BC Wildfire Service, and Elections BC.

The RLE should let you do the following:

- Specify a route list file to load and load it into the app.
- When loading, the app should validate each route in the list. We could also implement a stand-alone validator script that takes a route list and generate a validation report.
- Select a particular route to edit by route name, description, and maybe even tag names. For tag search to work, there needs to be a tags field in the Route List File format.
- Generate a route from the route parameters, display the resulting route line on a map, and display the route parameters in an editable form.
- Edit the route parameters and automatically regenerate a route.
- Save the edited route list to an existing file or a new file.
- There could be an option where RLE generates and displays all routes in the list so you can select a route to edit visually. However, we do anticipate route lists contains tens of thousands of routes so this option won’t be practical for these large lists.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.