Merge pull request #6 from ITSLeeds/3-otp-benchmark

3 otp benchmark

.gitignore

@@ -0,0 +1,9 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+
+*.Rproj
+
+
+OTP/*

test_otp.md

@@ -0,0 +1,175 @@
+# OTP benchmark
+
+
+``` r
+options(repos = c(CRAN = "https://cloud.r-project.org"))
+if (!require("remotes")) install.packages("remotes")
+pkgs = c(
+    "sf",
+    "tidyverse",
+    "osmextract",
+    "lwgeom",
+    "opentripplanner"
+)
+remotes::install_cran(pkgs)
+sapply(pkgs, require, character.only = TRUE)
+```
+
+    Warning in fun(libname, pkgname): PROJ versions differ: lwgeom has 9.3.0 sf has
+    9.3.1
+
+                 sf       tidyverse      osmextract          lwgeom opentripplanner 
+               TRUE            TRUE            TRUE            TRUE            TRUE 
+
+The following code is to test the performance of the OTP routing engine
+running locally controlled by the `opentripplanner` package with a
+sample of Origins and Destinations
+
+We will read the OD data produced for this test
+
+``` r
+od_geo = sf::read_sf("input_data/od_data_100_sf.geojson")
+```
+
+Extracting Origins and Destinations with the `'lwgeom` package
+
+``` r
+origins <- lwgeom::st_startpoint(od_geo) |> sf::st_as_sf()
+origins$O <- od_geo$O
+
+
+destinations <- lwgeom::st_endpoint(od_geo) |> sf::st_as_sf()
+destinations$D <- od_geo$D
+```
+
+### Setting up OTP
+
+The following codes will prepare the folders and files that are required
+for the OTP server to run
+
+#### Creating the folder structure
+
+We create a folder for the Leeds, which will be used as a router in the
+OTP functions
+
+``` r
+dir.create("OTP/graphs/Leeds",recursive = T,showWarnings = F)
+```
+
+Using the `osmextract` package we can extract the OSM data
+
+``` r
+leeds_osm <- osmextract::oe_get("Leeds",
+                                download_directory = "OTP/graphs/Leeds")
+```
+
+    No exact match found for place = Leeds and provider = geofabrik. Best match is Laos. 
+    Checking the other providers.
+
+    An exact string match was found using provider = bbbike.
+
+    The chosen file was already detected in the download directory. Skip downloading.
+
+    The corresponding gpkg file was already detected. Skip vectortranslate operations.
+
+    Reading layer `lines' from data source 
+      `C:\Users\ts18jpf\OneDrive - University of Leeds\03_PhD\00_Misc_projects\routingday\OTP\graphs\leeds\bbbike_Leeds.gpkg' 
+      using driver `GPKG'
+    Simple feature collection with 174124 features and 9 fields
+    Geometry type: LINESTRING
+    Dimension:     XY
+    Bounding box:  xmin: -1.889999 ymin: 53.65 xmax: -1.280002 ymax: 53.88
+    Geodetic CRS:  WGS 84
+
+Specifying the paths
+
+``` r
+path_data <- file.path("OTP")
+path_otp <- otp_dl_jar(path_data,cache = T)
+```
+
+    Using cached version from C:/Users/ts18jpf/AppData/Local/R/win-library/4.4/opentripplanner/jar/otp-1.5.0-shaded.jar
+
+Creating the config file for the router. For this purpose we are going
+to use the default values
+
+``` r
+if(!file.exists("OTP/graphs/leeds/router-config.json")){
+router_config <- otp_make_config("router")
+otp_validate_config(router_config)
+# router_config$routingDefaults$triangleSafetyFactor ### For quietness optimisation
+# router_config$routingDefaults$$triangleTimeFactor ### For speed optimisation
+otp_write_config(router_config,                # Save the config file
+                 dir = path_data,
+                 router = "Leeds")  
+}
+```
+
+We could also save some GTFS data at this poing, if needed. For this
+test we do not neet it, so we built the graph with the following code.
+
+``` r
+if(!file.exists("OTP/graphs/leeds/Graph.obj")){
+log1 <- otp_build_graph(otp = path_otp,router = "Leeds", dir = path_data,memory = 15000)
+}
+```
+
+We initialise the OTP server once the graph has been built
+
+``` r
+log2 <- otp_setup(otp = path_otp, dir = path_data,router = "Leeds",memory = 15e3)
+```
+
+    You have the correct version of Java for OTP 1.x
+
+    2024-08-08 15:36:13.910733 OTP is loading and may take a while to be useable
+
+    Router http://localhost:8080/otp/routers/Leeds exists
+
+    2024-08-08 15:36:44.309603 OTP is ready to use Go to localhost:8080 in your browser to view the OTP
+
+``` r
+otpcon <- otp_connect(timezone = "Europe/London",router = "Leeds")
+```
+
+    Router http://localhost:8080/otp/routers/Leeds exists
+
+Using the `otp_plan` function, we can generate the routes for the
+origins and destinations. We will use `system.time` to measure the time
+used for processing the routes
+
+``` r
+system.time({
+routes2 <- otp_plan(otpcon = otpcon,
+                    fromPlace = origins,
+                    toPlace = destinations,
+                    fromID = origins$O,
+                    toID = destinations$D,
+                    mode = "BICYCLE")
+})
+```
+
+    2024-08-08 15:36:44.979341 sending 100 routes requests using 19 threads
+
+    Done in 0 mins
+
+    2024-08-08 15:36:46.783542 processing results
+
+    6 routes returned errors. Unique error messages are:
+
+    5x messages: "No trip found. There may be no transit service within the maximum specified distance or at the specified time, or your start or end point might not be safely accessible."
+
+    1x messages: "We're sorry. The trip planner is temporarily unavailable. Please try again later."
+
+    2024-08-08 15:36:46.945192 done
+
+       user  system elapsed 
+       0.09    0.11    2.02 
+
+A quick look at the result
+
+``` r
+plot(routes2[,"geometry"])
+```
+
+![](test_otp_files/figure-commonmark/plot-routes-1.png)

test_otp.qmd

@@ -0,0 +1,123 @@
+---
+title: "OTP benchmark"
+format: gfm
+---
+
+```{r}
+#| label: packages
+#| message: false
+options(repos = c(CRAN = "https://cloud.r-project.org"))
+if (!require("remotes")) install.packages("remotes")
+pkgs = c(
+    "sf",
+    "tidyverse",
+    "osmextract",
+    "lwgeom",
+    "opentripplanner"
+)
+remotes::install_cran(pkgs)
+sapply(pkgs, require, character.only = TRUE)
+```
+
+The following code is to test the performance of the OTP routing engine running locally controlled by the `opentripplanner` package with a sample of Origins and Destinations
+
+We will read the OD data produced for this test
+```{r}
+#| label: read-data
+od_geo = sf::read_sf("input_data/od_data_100_sf.geojson")
+```
+
+Extracting Origins and Destinations with the `'lwgeom` package
+
+```{r}
+#| label: od-extract
+origins <- lwgeom::st_startpoint(od_geo) |> sf::st_as_sf()
+origins$O <- od_geo$O
+
+
+destinations <- lwgeom::st_endpoint(od_geo) |> sf::st_as_sf()
+destinations$D <- od_geo$D
+```
+
+
+### Setting up OTP
+
+The following codes will prepare the folders and files that are required for the OTP server to run
+
+#### Creating the folder structure
+
+We create a folder for the Leeds, which will be used as a router in the OTP functions
+```{r}
+#| label: dir-create
+dir.create("OTP/graphs/Leeds",recursive = T,showWarnings = F)
+```
+
+Using the `osmextract` package we can extract the OSM data
+```{r}
+#| label: osm-get
+leeds_osm <- osmextract::oe_get("Leeds",
+                                download_directory = "OTP/graphs/Leeds")
+```
+
+Specifying the paths
+
+```{r}
+#| label: dir-paths
+path_data <- file.path("OTP")
+path_otp <- otp_dl_jar(path_data,cache = T)
+```
+
+Creating the config file for the router. For this purpose we are going to use the default values
+```{r}
+#| label: setup-router
+if(!file.exists("OTP/graphs/leeds/router-config.json")){
+router_config <- otp_make_config("router")
+otp_validate_config(router_config)
+# router_config$routingDefaults$triangleSafetyFactor ### For quietness optimisation
+# router_config$routingDefaults$$triangleTimeFactor ### For speed optimisation
+otp_write_config(router_config,                # Save the config file
+                 dir = path_data,
+                 router = "Leeds")  
+}
+```
+
+We could also save some GTFS data at this poing, if needed. For this test we do not neet it, so 
+we built the graph with the following code.
+
+```{r}
+#| label: graph-prep
+if(!file.exists("OTP/graphs/leeds/Graph.obj")){
+log1 <- otp_build_graph(otp = path_otp,router = "Leeds", dir = path_data,memory = 15000)
+}
+```
+
+We initialise the OTP server once the graph has been built
+```{r}
+#| label: init-server
+log2 <- otp_setup(otp = path_otp, dir = path_data,router = "Leeds",memory = 15e3)
+otpcon <- otp_connect(timezone = "Europe/London",router = "Leeds")
+```
+
+Using the `otp_plan` function, we can generate the routes for the origins and destinations. We will use `system.time` to measure the time used for processing the routes
+```{r}
+#| label: route-extract
+system.time({
+routes2 <- otp_plan(otpcon = otpcon,
+                    fromPlace = origins,
+                    toPlace = destinations,
+                    fromID = origins$O,
+                    toID = destinations$D,
+                    mode = "BICYCLE")
+})
+```
+
+A quick look at the result
+
+```{r}
+#| label: plot-routes
+plot(routes2[,"geometry"])
+```
+
+
+
+