43 lines
858 B
Markdown
43 lines
858 B
Markdown
# Pipeline route calculation
|
|
|
|
A function that exposes the pipeline route calculations.
|
|
|
|
The pipeline route can be defined by various means
|
|
- `kml` route file
|
|
- `kmz` route file
|
|
- `csv` of the x,y, and optionally z coordinates of the pipeline.
|
|
|
|
If the elevation is missing, we utilise one of the following services to obtain
|
|
the elevation of each waypoint on the pipeline.
|
|
|
|
- Google maps
|
|
- Map box
|
|
- Open elevation
|
|
|
|
## Input
|
|
|
|
### Arguments
|
|
|
|
- TODO
|
|
|
|
### Environment
|
|
|
|
- `ORG_ID`: the organization id
|
|
- `PROJECT_ID`: the id of the data project where the pipeline data is found
|
|
- `ENV`: the environment of the platform e.g. `dev` or `stg` etc.
|
|
|
|
## Testing the function locally
|
|
|
|
You can run and test the function locally by running
|
|
|
|
```bash
|
|
cargo run
|
|
```
|
|
|
|
Then you can check it work with `curl` as follows
|
|
|
|
```bash
|
|
curl -X POST localhost:8080 -v \
|
|
-d "TODO"
|
|
```
|