Option to configure average-speed day by day (#57)

Author: larsen

.gitignore

@@ -4,3 +4,4 @@ public/
 .cpcache/
 .lsp/
 .nrepl-port
+.DS_Store

notebooks/rando-planner.clj

@@ -33,27 +33,29 @@
     (clerk/col
      (clerk/with-viewer diagram/plan-viewer example-plan)))))
 
-;; **rando-planner**:
 
-;; - allows users to break down the route with more control, providing
-;; visualization tools that help evaluating and comparing different
-;; plans
+;; When planning a long-distance bike ride, you face two main
+;; challenges: determining the route from point A to B, and organizing
+;; your journey—deciding how much distance to cover each day, when to
+;; take breaks, and where to refuel. Traditional route planners, such
+;; as Komoot, Strava, and Cycle.travel, primarily address the first
+;; challenge: designing the route.
 
-;; - assumes the user already has a GPX track defined (provided for
-;; example by the organizers of a bike event), and let the user plan
-;; the daily effort to a higher granularity.
+;; Komoot includes a tool for dividing the route into multiple days,
+;; but it simply distributes the distance evenly across
+;; them. Cycle.travel, on the other hand, allows users to break the
+;; route at specific points and even helps locate accommodations for
+;; overnight stays.
 
-;; - is based on Clerk, a notebook library for Clojure
+;; Rando-planner takes a different approach. It assumes you already
+;; have a GPX file of your route and focuses exclusively on the second
+;; challenge: planning your journey in detail.
 
-;; Traditional tools (such as Komoot, Strava, Cycle.travel, etc.)
-;; focus on planning the route itself. Komoot offers an extra tool to
-;; divide the route into multiple days, but they distribute distance
-;; uniformly across the days. Cycle.travel allows to break down the
-;; route at arbitrary points (and helps finding accomodation for the
-;; night).
+;; With rando-planner, users can divide the route into individual
+;; activities or daily plans. The tool provides visualization tools to
+;; assess daily effort with greater precision and compare various
+;; strategies for covering the distance effectively.
 
-;; rando-planner provides different types of visualization that can be
-;; used to study different strategies to cover the distance.
 
 ;; This page has been composed with Clerk and rando-planner
 
@@ -63,17 +65,18 @@
 
 ;; ## Features
 
-;; - Schematic visualization of the plan, that includes:
-;;   - running count of kilometers
-;;   - elevation
-;;   - scheduled pauses
-;;   - total amount of kilometers accumulated every day
-;;   - sunrise and sunset indicators (WIP)
-
-;; - Map visualization (based
-;;   on [Leaflet](https://github.com/Leaflet/Leaflet)) of the route,
-;;   with markers corresponding to the location reached after each day
-;;   is completed.
+;; - Schematic Visualization of the Plan
+;;   - Displays a comprehensive overview of your route, including:
+;;   - Running count of kilometers.
+;;   - Elevation profile.
+;;   - Scheduled pauses.
+;;   - Total distance accumulated daily.
+;;   - Sunrise and sunset indicators (currently a work in progress).
+;; - Daily Elevation Visualization
+;;   - Provides a focused view of the elevation profile for each day, helping you gauge the effort required for specific segments of the route.
+;; - Map Visualization
+;;   - Interactive mapping powered by Leaflet.
+;;   - Highlights the route with markers indicating the location reached at the end of each day.
 
 ;; ## Usage example
 
@@ -226,7 +229,7 @@ be morale-crushing."]])
 ;; end of the first day. Intermediate markers, when clicked, display a
 ;; popup that shows the label of the day that _ends_ there, and the
 ;; amount of kilometers planned for that day. With this information,
-;; you can use other tools to find accomodation or other services
+;; you can use other tools to find accommodation or other services
 ;; you're going to need on the road.
 
 ;; Here the new map, this time displayed taking advantage of all the
@@ -258,18 +261,24 @@ be morale-crushing."]])
 ;; - `:gpx`: This key refers to the location of a GPX (GPS Exchange
 ;;   Format) file
 
-;; - `:average-speed`: This key represents the average speed
-;;   maintained during the activities. The value associated with this
-;;   key is expected to be a numerical value denoting speed, expressed
-;;   as km/h
+;; - `:average-speed` [Optional]: When appears only at this level,
+;;   this key represents the average speed maintained during all the
+;;   activities. The value associated with this key is expected to be
+;;   a numerical value denoting speed, expressed as km/h.  If
+;;   `:average-speed` is used in a daily-plan (see below) then that
+;;   value overrides this option.
 
-;; - `:daily-plans`: This key holds a vector of daily plans. Each
-;;   daily plan is represented as a map containing information about
-;;   activities planned for a single day. Inside each element in the
-;;   vector:
+;; - `:daily-plans` [Optional]: This key holds a vector of daily
+;;   plans. If no daily-plans is provided, rando-planner will use a
+;;   default value (one single activity, long enough to cover the
+;;   entire distance). Each daily plan is represented as a map
+;;   containing information about activities planned for a single
+;;   day. Inside each element in the vector:
 
 ;;   - `:date`: This key denotes the date of the daily plan in the format "YYYY-MM-DD". It is used to compute the sun rise and set times.
 ;;   - `:label`: An arbitrary string, a label or description of the daily plan
+;;   - `:average-speed' [Optional]: The value associated with this key is expected to be
+;;       a numerical value denoting speed, expressed as km/h.
 ;;   - `:activities`: This key holds a vector of activities planned for the day. Each activity is represented as a map containing:
 ;;     - `:start`: This key denotes the starting time of an activity, in the format "HH:mm"
 ;;     - `:type`: This key specifies the type of activity. At the moment only the type "ride" is in use. This key is reserved for future uses

src/rando_planner/diagram.clj

@@ -158,16 +158,23 @@
                     :dominant-baseline "hanging"
                     :fill (get-from-palette :elevation-legend-stroke)}
              (str "▲ " (Math/floor (:elevation d)) " m")]
+            [:text {:x (+ dx1 2)
+                    :y 39
+                    :font-family "Fira Sans"
+                    :font-size "60%"
+                    :dominant-baseline "hanging"
+                    :fill (get-from-palette :elevation-legend-stroke)}
+             (str "🚄 " (:average-speed d) " km/h")]
             [:rect {:x dx1
-                    :y 0
-                    :width dx2 :height bottom-right-y
-                    :fill (get-alternating-background!)
-                    :fill-opacity 0.4}]
+                       :y 0
+                       :width dx2 :height bottom-right-y
+                       :fill (get-alternating-background!)
+                       :fill-opacity 0.4}]
             (when (:pauses d)
               (for [p (:pauses d)]
                 (let [{px :x} (pointspace-to-viewbox-space
                                {:x (+ (:covered d)
-                                      (* average-speed
+                                      (* (:average-speed d)
                                          (- (:after p)
                                             (:cumulative-pause p))))
                                 :y 0  ; not important, not used
@@ -286,7 +293,7 @@
 
 (defn day-plan->svg [plan index km center]
   (let [day-plan (nth (:daily-plans plan) index)
-        average-speed (:average-speed plan)
+        average-speed (plan/average-speed day-plan plan)
         elevation (gpx/elevation (:gpx plan))
         pauses (plan/pauses day-plan)
         main-offset (* (/ km average-speed) box-size)

src/rando_planner/plan.clj

@@ -13,6 +13,15 @@
   (tick/>> (tick/time start)
            (tick/new-duration n :hours)))
 
+(def default-average-speed 18)
+
+(defn average-speed
+  ([day-plan] (or (:average-speed day-plan)
+                  default-average-speed))
+  ([day-plan plan] (or (:average-speed day-plan)
+                       (:average-speed plan)
+                       default-average-speed)))
+
 (defn kilometers-in-a-day [day-plan average-speed]
   (reduce + (map #(* (:length %) average-speed)
                  (filter #(= (:type %) :ride)
@@ -54,8 +63,7 @@
   "Given a plan, it returns a vector of structures containing how many
   kilometers are done in each day, and from what kilometer each day starts"
   [plan]
-  (let [default-average-speed 20
-        default-daily-plans [{:date (str (tick/today))
+  (let [default-daily-plans [{:date (str (tick/today))
                               :label "_day0"
                               :activities [{:start "05:00"
                                             :type :ride
@@ -71,12 +79,13 @@
            acc-km 0
            i 0]
       (if (< i (count daily-plans))
-        (let [km (kilometers-in-a-day (nth daily-plans i)
-                                      (or (:average-speed plan)
-                                          default-average-speed))]
+        (let [daily-plan (nth daily-plans i)
+              average-speed (average-speed daily-plan plan)
+              km (kilometers-in-a-day daily-plan average-speed)]
           (recur (conj result
                        {:day (+ 1 i)
                         :label (:label (nth daily-plans i))
+                        :average-speed average-speed
                         :kilometers km
                         :covered acc-km
                         :elevation (gpx/elevation-gain elevation
@@ -91,7 +100,7 @@
                                           (gpx/points (:gpx plan)))]
     (map (fn [d]
            (filter #(and (>= (:cumulative-distance %)
-                            (:covered d))
+                             (:covered d))
                          (< (:cumulative-distance %)
                             (+ (:covered d)
                                (:kilometers d))))
@@ -104,6 +113,7 @@
 
   :day
   :cumulative-distance
+  :average-speed
   :elevation
   :ele
   :label
@@ -118,11 +128,11 @@
                                             gpx/with-cumulative-distance)
         daily-distance (daily-distance plan)
         points-at-end-of-days (for [dk daily-distance]
-                                (first (filter (fn [p]
-                                                 (> (:cumulative-distance p)
-                                                    (+ (:covered dk)
-                                                       (:kilometers dk))))
-                                               points-with-cumulative-distance)))
+                                   (first (filter (fn [p]
+                                                      (> (:cumulative-distance p)
+                                                         (+ (:covered dk)
+                                                            (:kilometers dk))))
+                                                  points-with-cumulative-distance)))
         daily-pauses (vec (map
                            (fn [pauses]
                              {:pauses pauses})