Spaces:
Build error
Build error
docs: Update MR description for dev_skeleton_and_features branch
Browse files- MR_DESCRIPTION.md +12 -9
MR_DESCRIPTION.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
| 1 |
-
# Merge Request / Pull Request Description: Phase 2 - Functional + POI Integration
|
| 2 |
|
| 3 |
## π Overview
|
| 4 |
-
This Merge Request delivers **Phase 2: Functional + POI Integration** for the **Trailhead** project. It introduces live and offline Points of Interest (POI) extraction via OpenStreetMap (Overpass API), integrates a local Wilderness First-Aid medical manual RAG search, and implements a full route simulation player with metrics HUD
|
| 5 |
|
| 6 |
## π Key Changes
|
| 7 |
1. **POI Integration (`gpx_parser.py`)**:
|
| 8 |
-
* Fetches key POIs (drinking water, spring, huts, shelters, campsites) dynamically within a custom bounding box of the track via the **OSM Overpass API**.
|
| 9 |
* Filters amenities locally using the **Haversine formula** within a 150m buffer of the route.
|
| 10 |
* Serializes/saves POIs into GPX XML `<extensions>` and `<wpt>` tags via `save_enhanced_gpx` for offline capabilities.
|
| 11 |
2. **Wilderness First-Aid Guide (`first_aid_guide.json` & `rag.py`)**:
|
|
@@ -16,20 +16,23 @@ This Merge Request delivers **Phase 2: Functional + POI Integration** for the **
|
|
| 16 |
* Displays dashboard metrics (Route progress %, distance walked, altitude, and dynamic ETA to next checkpoint).
|
| 17 |
* Sounds/shows offline proximity alerts when within 150m of any drinking water, camp, or hut.
|
| 18 |
* Integrated Wilderness First-Aid tab with static emergency cards and RAG manual search.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
## π οΈ Verification Done
|
| 21 |
* Created [test_overpass.py](file:///c:/Users/skushwaha/Documents/hckthn/TrailHead/test_overpass.py) to parse the preloaded Trento Track.
|
| 22 |
-
* Verified Overpass API (`https://overpass-api.de/api/interpreter`) fetched, filtered, and returned
|
| 23 |
* Validated that the first-aid RAG keyword search retrieves correct sections and references them.
|
|
|
|
| 24 |
|
| 25 |
---
|
| 26 |
|
| 27 |
## π Steps to Push to GitHub
|
| 28 |
```bash
|
| 29 |
-
#
|
| 30 |
-
git
|
| 31 |
-
|
| 32 |
-
# Push all files to main
|
| 33 |
-
git push -u origin main
|
| 34 |
```
|
| 35 |
|
|
|
|
|
|
| 1 |
+
# Merge Request / Pull Request Description: Phase 2 - Functional + POI Integration (dev_skeleton_and_features)
|
| 2 |
|
| 3 |
## π Overview
|
| 4 |
+
This Merge Request delivers **Phase 2: Functional + POI Integration** for the **Trailhead** project. It introduces live and offline Points of Interest (POI) extraction via OpenStreetMap (Overpass API), integrates a local Wilderness First-Aid medical manual RAG search, and implements a full route simulation player with metrics HUD, proximity alert indicators, and smooth Leaflet map marker rendering.
|
| 5 |
|
| 6 |
## π Key Changes
|
| 7 |
1. **POI Integration (`gpx_parser.py`)**:
|
| 8 |
+
* Fetches key POIs (drinking water, spring, huts, shelters, campsites, viewpoint, peak, emergency phone) dynamically within a custom bounding box of the track via the **OSM Overpass API**.
|
| 9 |
* Filters amenities locally using the **Haversine formula** within a 150m buffer of the route.
|
| 10 |
* Serializes/saves POIs into GPX XML `<extensions>` and `<wpt>` tags via `save_enhanced_gpx` for offline capabilities.
|
| 11 |
2. **Wilderness First-Aid Guide (`first_aid_guide.json` & `rag.py`)**:
|
|
|
|
| 16 |
* Displays dashboard metrics (Route progress %, distance walked, altitude, and dynamic ETA to next checkpoint).
|
| 17 |
* Sounds/shows offline proximity alerts when within 150m of any drinking water, camp, or hut.
|
| 18 |
* Integrated Wilderness First-Aid tab with static emergency cards and RAG manual search.
|
| 19 |
+
4. **Flicker-Free Map Rendering (Leaflet)**:
|
| 20 |
+
* Embedded Leaflet map container directly in the parent window.
|
| 21 |
+
* Wired data exchange using JSON state strings via a hidden Gradio textbox, completely eliminating iframe reload flickering during simulation updates.
|
| 22 |
+
* Rendered POIs with distinct colored circle markers (Blue for water, Green for huts, Orange for camps, Purple for peaks, Red for phone) for offline compatibility.
|
| 23 |
|
| 24 |
## π οΈ Verification Done
|
| 25 |
* Created [test_overpass.py](file:///c:/Users/skushwaha/Documents/hckthn/TrailHead/test_overpass.py) to parse the preloaded Trento Track.
|
| 26 |
+
* Verified Overpass API (`https://overpass-api.de/api/interpreter`) fetched, filtered, and returned amenities successfully within a 150m buffer.
|
| 27 |
* Validated that the first-aid RAG keyword search retrieves correct sections and references them.
|
| 28 |
+
* Tested the simulation playback, ensuring coordinates update smoothly and map centers without flickering.
|
| 29 |
|
| 30 |
---
|
| 31 |
|
| 32 |
## π Steps to Push to GitHub
|
| 33 |
```bash
|
| 34 |
+
# Push the current branch to GitHub
|
| 35 |
+
git push -u origin dev_skeleton_and_features
|
|
|
|
|
|
|
|
|
|
| 36 |
```
|
| 37 |
|
| 38 |
+
|