Add instructions to locally run the benchmarks

Author: avik-pal

.gitignore

@@ -6,4 +6,6 @@ Manifest.toml
 .vscode/*
 wip
 /.benchmarkci
-/benchmark/*.json
+/benchmark/*.json
+*.json
+*.json.tmp

README.md

@@ -59,3 +59,13 @@ using Preferences, UUIDs
 Preferences.set_preferences!(UUID("764a87c0-6b3e-53db-9096-fe964310641d"),
     "PrecompileShooting" => false)
 ```
+
+## Running Benchmarks Locally
+
+We include a small set of benchmarks in the `benchmarks` folder. These are not extensive and mainly used to track regressions during development. For more extensive benchmarks, see the [SciMLBenchmarks](https://github.com/SciML/SciMLBenchmarks.jl) repository.
+
+To run benchmarks locally install [AirspeedVelocity.jl](https://github.com/MilesCranmer/AirspeedVelocity.jl) and run the following command in the package directory:
+
+```bash
+benchpkg BoundaryValueDiffEq --rev="master,<git sha for your commit>" --bench-on="master"
+```

benchmark/simple_pendulum.jl

@@ -28,8 +28,8 @@ function bc_pendulum(u, p, t)
     return [u((t0 + t1) / 2)[1] + π / 2, u(t1)[1] - π / 2]
 end
 
-const prob_oop = BVProblem(simple_pendulum, bc_pendulum, [π / 2, π / 2], tspan)
-const prob_iip = BVProblem(simple_pendulum!, bc_pendulum!, [π / 2, π / 2], tspan)
+const prob_oop = BVProblem{false}(simple_pendulum, bc_pendulum, [π / 2, π / 2], tspan)
+const prob_iip = BVProblem{true}(simple_pendulum!, bc_pendulum!, [π / 2, π / 2], tspan)
 
 end
 
@@ -42,27 +42,35 @@ function create_simple_pendulum_benchmark()
     suite["IIP"] = iip_suite
     suite["OOP"] = oop_suite
 
-    iip_suite["MultipleShooting(100, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
-        $MultipleShooting(100, Tsit5()))
-    iip_suite["MultipleShooting(100, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
-        $MultipleShooting(100, Tsit5(); grid_coarsening = false))
-    iip_suite["MultipleShooting(10, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
-        $MultipleShooting(10, Tsit5()))
-    iip_suite["MultipleShooting(10, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
-        $MultipleShooting(10, Tsit5(); grid_coarsening = false))
-    iip_suite["Shooting(Tsit5())"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
-        $Shooting(Tsit5()))
+    if @isdefined(MultipleShooting)
+        iip_suite["MultipleShooting(100, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
+            $MultipleShooting(100, Tsit5()))
+        iip_suite["MultipleShooting(100, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
+            $MultipleShooting(100, Tsit5(); grid_coarsening = false))
+        iip_suite["MultipleShooting(10, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
+            $MultipleShooting(10, Tsit5()))
+        iip_suite["MultipleShooting(10, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
+            $MultipleShooting(10, Tsit5(); grid_coarsening = false))
+    end
+    if @isdefined(Shooting)
+        iip_suite["Shooting(Tsit5())"] = @benchmarkable solve($SimplePendulumBenchmark.prob_iip,
+            $Shooting(Tsit5()))
+    end
 
-    oop_suite["MultipleShooting(100, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
-        $MultipleShooting(100, Tsit5()))
-    oop_suite["MultipleShooting(100, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
-        $MultipleShooting(100, Tsit5(); grid_coarsening = false))
-    oop_suite["MultipleShooting(10, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
-        $MultipleShooting(10, Tsit5()))
-    oop_suite["MultipleShooting(10, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
-        $MultipleShooting(10, Tsit5(); grid_coarsening = false))
-    oop_suite["Shooting(Tsit5())"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
-        $Shooting(Tsit5()))
+    if @isdefined(MultipleShooting)
+        oop_suite["MultipleShooting(100, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
+            $MultipleShooting(100, Tsit5()))
+        oop_suite["MultipleShooting(100, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
+            $MultipleShooting(100, Tsit5(); grid_coarsening = false))
+        oop_suite["MultipleShooting(10, Tsit5; grid_coarsening = true)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
+            $MultipleShooting(10, Tsit5()))
+        oop_suite["MultipleShooting(10, Tsit5; grid_coarsening = false)"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
+            $MultipleShooting(10, Tsit5(); grid_coarsening = false))
+    end
+    if @isdefined(Shooting)
+        oop_suite["Shooting(Tsit5())"] = @benchmarkable solve($SimplePendulumBenchmark.prob_oop,
+            $Shooting(Tsit5()))
+    end
 
     return suite
 end