feat: Elevation Gain (#719)

* feat: elevation gain - strava/garmin(gpx/tcx/fit)

* feat: elevation gain - keep: elevation & gpx type

* feat: elevation gain - keep: elevation & gpx type

* feat: elevation gain - ui

* feat: joyrun gpx: elevation and heart_rate

* feat: elevation gain - joyrun

* feat: elevation gain - keep

* feat: elevation gain - gpx

* feat: elevation gain - oppo

* feat: elevation gain - tulipsport

* feat: elevation gain - field name

* feat: elevation gain - db updator

* feat: elevation gain - fix

* doc: update notice

* feat: elevation gain display switch, default not show

---------

Signed-off-by: yihong0618 <[email protected]>
Co-authored-by: yihong0618 <[email protected]>

Author: ben-29

.github/workflows/run_data_sync.yml

@@ -25,7 +25,7 @@ on:
 
 env:
   # please change to your own config.
-  RUN_TYPE: pass # support strava/nike/garmin/coros/garmin_cn/garmin_sync_cn_global/keep/only_gpx/only_fit/nike_to_strava/strava_to_garmin/tcx_to_garmin/strava_to_garmin_cn/garmin_to_strava/garmin_to_strava_cn/codoon/oppo, Please change the 'pass' it to your own
+  RUN_TYPE: pass # support strava/nike/garmin/coros/garmin_cn/garmin_sync_cn_global/keep/only_gpx/only_fit/nike_to_strava/strava_to_garmin/tcx_to_garmin/strava_to_garmin_cn/garmin_to_strava/garmin_to_strava_cn/codoon/oppo/db_updater, Please change the 'pass' it to your own
   ATHLETE: yihong0618
   TITLE: Yihong0618 Running
   MIN_GRID_DISTANCE: 10 # change min distance here
@@ -204,6 +204,11 @@ jobs:
         # If you want to sync fit activity in gpx format, please consider the following script:
         # python run_page/oppo_sync.py ${{ secrets.OPPO_ID }} ${{ secrets.OPPO_CLIENT_SECRET }} ${{ secrets.OPPO_CLIENT_REFRESH_TOKEN }} --with-gpx
 
+      - name: Run db updater script to add "Elevation Gain" field to db
+        if: env.RUN_TYPE == 'db_updater'
+        run: |
+            python run_page/db_updater.py
+
       - name: Make svg GitHub profile
         if: env.RUN_TYPE != 'pass'
         env:

README-CN.md

@@ -4,12 +4,23 @@
 2. python3(python) in README means python3 python
 3. use v2.0 need change vercel setting from gatsby to vite
 4. 2023.09.26 garmin need secret_string(and in Actions) get
+    
+    ```bash
+      python run_page/get_garmin_secret.py ${email} ${password}
+      # if cn
+      python run_page/get_garmin_secret.py ${email} ${password} --is-cn
+    ```
 
-```bash
-  python run_page/get_garmin_secret.py ${email} ${password}
-  # if cn
-  python run_page/get_garmin_secret.py ${email} ${password} --is-cn
-```
+5. 2024.09.29: Added `Elevation Gain` field, If you forked the project before this update, please run the following command:
+    - To resolve errors: `sqlalchemy.exc.OperationalError: (sqlite3.OperationalError) no such column: activities.elevation_gain`
+    - If you don't have a local environment, set `RUN_TYPE` to `db_updater` in the `.github/workflows/run_data_sync.yml` file once then change back. 
+
+    ```bash
+      python run_page/db_updater.py
+    ```
+    - For old data: To include `Elevation Gain` for past activities, perform a full reimport. 
+    - To show the 'Elevation Gain' column, modify `SHOW_ELEVATION_GAIN` in `src/utils/const.ts`
+    - note: `Elevation Gain` may be inaccurate. You can use Strava's "Correct Elevation" or Garmin's "Elev Corrections" feature for more precise data. 
 
 ![running_page](https://socialify.git.ci/yihong0618/running_page/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fshaonianche%2Fgallery%2Fmaster%2Frunning_page%2Frunning_page_logo_150*150.jpg&owner=1&pulls=1&stargazers=1&theme=Light)
 
@@ -252,10 +263,13 @@ const LINE_OPACITY = 0.4;
 // update for now 2024/11/17 the privacy mode is true
 // styling: 开启隐私模式 (不显示地图仅显示轨迹): 设置为 `true`
 // 注意：此配置仅影响页面显示，数据保护请参考下方的 "隐私保护"
+const PRIVACY_MODE = false;
+// styling: 默认关灯: 设置为 `false`, 仅在隐私模式关闭时生效(`PRIVACY_MODE` = false)
+const LIGHTS_ON = true;
+// styling: 是否显示列 ELEVATION_GAIN
+const SHOW_ELEVATION_GAIN = false;
 const PRIVACY_MODE = true;
 // update for now 2024/11/17 the lights on default is false
-// styling: 默认关灯：设置为 `false`, 仅在隐私模式关闭时生效 (`PRIVACY_MODE` = false)
-const LIGHTS_ON = false;
 ```
 
 > 隐私保护：设置下面环境变量：

README.md

@@ -3,13 +3,23 @@
 1. clone or Fork before vercel 404 need to pull the latest code
 2. python3(python) in README means python3 python
 3. use v2.0 need change vercel setting from gatsby to vite
-4. 2023.09.26 garmin need secret_string(and in Actions) get
-
-```bash
-  python run_page/get_garmin_secret.py ${email} ${password}
-  # if cn
-  python run_page/get_garmin_secret.py ${email} ${password} --is-cn
-```
+4. 2023.09.26 garmin need secret_string(and in Actions) get    
+    ```bash
+      python run_page/get_garmin_secret.py ${email} ${password}
+      # if cn
+      python run_page/get_garmin_secret.py ${email} ${password} --is-cn
+    ```
+
+5. 2024.09.29: Added `Elevation Gain` field, If you forked the project before this update, please run the following command:
+    - To resolve errors: `sqlalchemy.exc.OperationalError: (sqlite3.OperationalError) no such column: activities.elevation_gain`
+    - If you don't have a local environment, set `RUN_TYPE` to `db_updater` in the `.github/workflows/run_data_sync.yml` file once then change back. 
+
+    ```bash
+      python run_page/db_updater.py
+    ```
+    - For old data: To include `Elevation Gain` for past activities, perform a full reimport. 
+    - To show the 'Elevation Gain' column, modify `SHOW_ELEVATION_GAIN` in `src/utils/const.ts`
+    - note: `Elevation Gain` may be inaccurate. You can use Strava's "Correct Elevation" or Garmin's "Elev Corrections" feature for more precise data. 
 
 <p align="center">
   <img width="150" src="https://raw.githubusercontent.com/shaonianche/gallery/master/running_page/running_page_logo.png" />
@@ -243,6 +253,8 @@ const PRIVACY_MODE = true;
 // update for now 2024/11/17 the lights on default is false
 // styling: set to `false` if you want to make light off as default, only effect when `PRIVACY_MODE` = false
 const LIGHTS_ON = false;
+// set to `true` if you want to show the 'Elevation Gain' column
+const SHOW_ELEVATION_GAIN = true;
 ```
 
 - To use Google Analytics, you need to modify the configuration in the `src/utils/const.ts` file.

run_page/codoon_sync.py

@@ -477,7 +477,7 @@ def parse_points_to_gpx(self, run_points_data):
         for p in points_dict_list:
             point = gpxpy.gpx.GPXTrackPoint(**p)
             gpx_segment.points.append(point)
-        return gpx.to_xml()
+        return gpx
 
     def get_single_run_record(self, route_id):
         print(f"Get single run for codoon id {route_id}")
@@ -528,11 +528,14 @@ def parse_raw_data_to_namedtuple(
                     p["latitude"] = latlng_data[i][0]
                     p["longitude"] = latlng_data[i][1]
 
-        if with_gpx:
-            # pass the track no points
-            if str(log_id) not in old_gpx_ids and run_points_data:
-                gpx_data = self.parse_points_to_gpx(run_points_data)
-                download_codoon_gpx(gpx_data, str(log_id))
+        elevation_gain = None
+        if run_points_data:
+            gpx_data = self.parse_points_to_gpx(run_points_data)
+            elevation_gain = gpx_data.get_uphill_downhill().uphill
+            if with_gpx:
+                # pass the track no points
+                if str(log_id) not in old_gpx_ids:
+                    download_codoon_gpx(gpx_data.to_xml(), str(log_id))
         heart_rate_dict = run_data.get("heart_rate")
         heart_rate = None
         if heart_rate_dict:
@@ -570,6 +573,7 @@ def parse_raw_data_to_namedtuple(
                 seconds=int((end_date.timestamp() - start_date.timestamp()))
             ),
             "average_speed": run_data["total_length"] / run_data["total_time"],
+            "elevation_gain": elevation_gain,
             "location_country": location_country,
             "source": "Codoon",
         }

run_page/db_updater.py

@@ -0,0 +1,25 @@
+from generator.db import init_db, Activity
+from config import SQL_FILE
+import sqlalchemy
+from sqlalchemy import text
+from config import GPX_FOLDER, JSON_FILE
+from utils import make_activities_file
+
+
+def add_column_elevation_gain(session):
+    # check if column elevation_gain is already added
+    # if not add it to the db
+    try:
+        session.query(Activity).first()
+        print("column elevation_gain already added, skipping")
+    except sqlalchemy.exc.OperationalError:
+        sql_statement = 'alter TABLE "activities" add column elevation_gain Float after average_heartrate'
+        session.execute(text(sql_statement))
+        print("column elevation_gain added successfully")
+
+
+if __name__ == "__main__":
+    session = init_db(SQL_FILE)
+    add_column_elevation_gain(session)
+    # regenerate activities
+    make_activities_file(SQL_FILE, GPX_FOLDER, JSON_FILE)

run_page/endomondo_sync.py

@@ -69,6 +69,7 @@ def parse_run_endomondo_to_nametuple(en_dict):
         "average_speed": en_dict.get("distance_km", 0)
         / en_dict.get("duration_s", 1)
         * 1000,
+        "elevation_gain": None,
         "location_country": "",
     }
     return namedtuple("x", d.keys())(*d.values())

run_page/generator/__init__.py

@@ -72,6 +72,8 @@ def sync(self, force):
                     activity.map.summary_polyline = filter_out(
                         activity.map.summary_polyline
                     )
+            #  strava use total_elevation_gain as elevation_gain
+            activity.elevation_gain = activity.total_elevation_gain
             activity.subtype = activity.type
             created = update_or_create_activity(self.session, activity)
             if created:

run_page/generator/db.py

@@ -44,6 +44,7 @@ def randomword():
     "summary_polyline",
     "average_heartrate",
     "average_speed",
+    "elevation_gain",
 ]
 
 
@@ -63,6 +64,7 @@ class Activity(Base):
     summary_polyline = Column(String)
     average_heartrate = Column(Float)
     average_speed = Column(Float)
+    elevation_gain = Column(Float)
     streak = None
 
     def to_dict(self):
@@ -122,6 +124,7 @@ def update_or_create_activity(session, run_activity):
                 location_country=location_country,
                 average_heartrate=run_activity.average_heartrate,
                 average_speed=float(run_activity.average_speed),
+                elevation_gain=float(run_activity.elevation_gain),
                 summary_polyline=(
                     run_activity.map and run_activity.map.summary_polyline or ""
                 ),
@@ -137,6 +140,7 @@ def update_or_create_activity(session, run_activity):
             activity.subtype = run_activity.subtype
             activity.average_heartrate = run_activity.average_heartrate
             activity.average_speed = float(run_activity.average_speed)
+            activity.elevation_gain = float(run_activity.elevation_gain)
             activity.summary_polyline = (
                 run_activity.map and run_activity.map.summary_polyline or ""
             )

run_page/gpxtrackposter/track.py

@@ -49,6 +49,7 @@ def __init__(self):
         self.length = 0
         self.special = False
         self.average_heartrate = None
+        self.elevation_gain = None
         self.moving_dict = {}
         self.run_id = 0
         self.start_latlng = []
@@ -171,6 +172,7 @@ def _load_tcx_data(self, tcx, file_name):
             except:
                 pass
             self.polyline_str = polyline.encode(polyline_container)
+        self.elevation_gain = tcx.ascent
         self.moving_dict = {
             "distance": self.length,
             "moving_time": datetime.timedelta(seconds=moving_time),
@@ -236,6 +238,7 @@ def _load_gpx_data(self, gpx):
             sum(heart_rate_list) / len(heart_rate_list) if heart_rate_list else None
         )
         self.moving_dict = self._get_moving_data(gpx)
+        self.elevation_gain = gpx.get_uphill_downhill().uphill
 
     def _load_fit_data(self, fit: dict):
         _polylines = []
@@ -319,6 +322,10 @@ def append(self, other):
             )
             self.file_names.extend(other.file_names)
             self.special = self.special or other.special
+            self.average_heartrate = self.average_heartrate or other.average_heartrate
+            self.elevation_gain = (
+                self.elevation_gain if self.elevation_gain else 0
+            ) + (other.elevation_gain if other.elevation_gain else 0)
         except:
             print(
                 f"something wrong append this {self.end_time},in files {str(self.file_names)}"
@@ -355,6 +362,7 @@ def to_namedtuple(self, run_from="gpx"):
             "average_heartrate": (
                 int(self.average_heartrate) if self.average_heartrate else None
             ),
+            "elevation_gain": (int(self.elevation_gain) if self.elevation_gain else 0),
             "map": run_map(self.polyline_str),
             "start_latlng": self.start_latlng,
         }

run_page/joyrun_sync.py

@@ -324,7 +324,7 @@ def parse_points_to_gpx(
             )
         )
 
-        return gpx.to_xml()
+        return gpx
 
     def get_single_run_record(self, fid):
         payload = {
@@ -363,13 +363,33 @@ def parse_raw_data_to_nametuple(self, run_data, old_gpx_ids, with_gpx=False):
                 eval(run_data["heartrate"]) if run_data["heartrate"] else None
             )
         except:
-            print(f"Heart Rate: can not eval for {str(heart_rate_list)}")
+            print(f"Heart Rate: can not eval for {str(run_data['heartrate'''])}")
+        try:
+            altitude_list = eval(altitude_list) if altitude_list else None
+        except:
+            print(f"Altitude: can not eval for {str(altitude_list)}")
         heart_rate = None
         if heart_rate_list:
             heart_rate = int(sum(heart_rate_list) / len(heart_rate_list))
             # fix #66
             if heart_rate < 0:
                 heart_rate = None
+        elevation_gain = None
+        # pass the track no points
+        if run_points_data:
+            gpx_data = self.parse_points_to_gpx(
+                run_points_data,
+                start_time,
+                end_time,
+                heart_rate_list,
+                altitude_list,
+                pause_list,
+            )
+            elevation_gain = gpx_data.get_uphill_downhill().uphill
+            if with_gpx:
+                # pass the track no points
+                if str(joyrun_id) not in old_gpx_ids:
+                    download_joyrun_gpx(gpx_data.to_xml(), str(joyrun_id))
 
         polyline_str = polyline.encode(run_points_data) if run_points_data else ""
         start_latlng = start_point(*run_points_data[0]) if run_points_data else None
@@ -404,6 +424,7 @@ def parse_raw_data_to_nametuple(self, run_data, old_gpx_ids, with_gpx=False):
                 seconds=int((run_data["endtime"] - run_data["starttime"]))
             ),
             "average_speed": run_data["meter"] / run_data["second"],
+            "elevation_gain": elevation_gain,
             "location_country": location_country,
         }
         return namedtuple("x", d.keys())(*d.values())