Merge pull request #120 from JGreenlee/update-label-options-spec

update custom label-options to new specification
e-mission · Sep 27, 2024 · ae602f1 · ae602f1
2 parents 9faf8be + f3f5b37
commit ae602f1
Show file tree

Hide file tree

Showing 9 changed files with 280 additions and 477 deletions.
diff --git a/.github/ISSUE_TEMPLATE/add-new-config.yml b/.github/ISSUE_TEMPLATE/add-new-config.yml
@@ -322,7 +322,7 @@ body:
   attributes:
     label: Custom Labels
     description: If you chose false above, and want drowdown style labeling, please provide the file name for your custom labels. You will need to submit a PR to add it to our repo - https://github.com/e-mission/nrel-openpath-deploy-configs/tree/main/label_options
-    placeholder: example-program-label-options.json
+    placeholder: your-program-name-label-options.json
 
 - type: markdown
   attributes:

diff --git a/configs/dev-emulator-program.nrel-op.json b/configs/dev-emulator-program.nrel-op.json
@@ -24,7 +24,6 @@
             }
         }
     },
-    "label_options": "https://raw.githubusercontent.com/e-mission/nrel-openpath-deploy-configs/main/label_options/example-program-label-options.json",
     "display_config": {
         "use_imperial": false
     },

diff --git a/configs/dev-emulator-study.nrel-op.json b/configs/dev-emulator-study.nrel-op.json
@@ -23,7 +23,6 @@
             }
         }
     },
-    "label_options": "https://raw.githubusercontent.com/e-mission/nrel-openpath-deploy-configs/main/label_options/example-study-label-options.json",
     "display_config": {
         "use_imperial": false
     },

diff --git a/label_options/caebike-label-options.json b/label_options/caebike-label-options.json
@@ -1,15 +1,25 @@
 {
   "MODE": [
-    {"value":"walk_run", "baseMode":"WALKING", "met": {"ALL": {"range": [0, -1], "mets": 3}}, "kgCo2PerKm": 0},
-    {"value":"auto_driver", "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.22031},
-    {"value":"auto_passenger", "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.110155},
-    {"value":"e-bike", "baseMode":"E_BIKE", "met": {"ALL": {"range": [0, -1], "mets": 5}}, "kgCo2PerKm": 0.00728},
-    {"value":"bike", "baseMode":"BICYCLING", "met": {"ALL": {"range": [0, -1], "mets": 6}}, "kgCo2PerKm": 0},
-    {"value":"taxi", "baseMode":"TAXI", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.30741},
-    {"value":"bike_scooter_share", "baseMode":"BICYCLING", "met": {"ALL": {"range": [0, -1], "mets": 3.5}}, "kgCo2PerKm": 0.00447},
-    {"value":"bus_train", "baseMode":"BUS", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.179033},
-    {"value":"other_mode", "baseMode":"OTHER", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0},
-    {"value":"not_a_trip", "baseMode":"UNKNOWN", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0}   
+    {"value":"walk_run", "base_mode": "WALKING", "met": {"ALL": {"range": [0, -1], "mets": 3}},
+      "baseMode":"WALKING", "kgCo2PerKm": 0},
+    {"value":"auto_driver", "base_mode": "CAR",
+      "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.22031},
+    {"value":"auto_passenger", "base_mode": "CAR", "passengers": 2,
+      "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.110155},
+    {"value":"e-bike", "base_mode": "E_BIKE",
+      "baseMode":"E_BIKE", "met": {"ALL": {"range": [0, -1], "mets": 5}}, "kgCo2PerKm": 0.00728},
+    {"value":"bike", "base_mode": "BICYCLING",
+      "baseMode":"BICYCLING", "met": {"ALL": {"range": [0, -1], "mets": 6}}, "kgCo2PerKm": 0},
+    {"value":"taxi", "base_mode": "TAXI",
+      "baseMode":"TAXI", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.30741},
+    {"value":"bike_scooter_share", "base_mode": "BICYCLING", "footprint": {"electric": {"wh_per_km": 8.39, "wh_per_trip": 2.05 }},
+      "baseMode":"BICYCLING", "met": {"ALL": {"range": [0, -1], "mets": 3.5}}, "kgCo2PerKm": 0.00447},
+    {"value":"bus_train", "base_mode": "BUS",
+      "baseMode":"BUS", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.179033},
+    {"value":"other_mode", "base_mode": "OTHER",
+      "baseMode":"OTHER", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0},
+    {"value":"not_a_trip", "base_mode": "NONE",
+      "baseMode":"NONE", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0}   
   ],
   "PURPOSE": [
     {"value":"to_home"},

diff --git a/label_options/example-program-label-options.json b/label_options/example-program-label-options.json
diff --git a/label_options/example-study-label-options.json b/label_options/example-study-label-options.json
diff --git a/label_options/godcgo-label-options.json b/label_options/godcgo-label-options.json
@@ -1,20 +1,35 @@
 {
   "MODE": [
-    {"value":"walk", "baseMode":"WALKING", "met_equivalent":"WALKING", "kgCo2PerKm": 0},
-    {"value":"bike", "baseMode":"BICYCLING", "met_equivalent":"BICYCLING", "kgCo2PerKm": 0},
-    {"value":"scootershare", "baseMode":"E_SCOOTER", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.00894},
-    {"value":"drove_alone", "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.22031},
-    {"value":"shared_ride", "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.11015},
-    {"value":"e_car_drove_alone", "baseMode":"E_CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.08216},
-    {"value":"e_car_shared_ride", "baseMode":"E_CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.04108},
-    {"value":"moped", "baseMode":"MOPED", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.05555},
-    {"value":"taxi", "baseMode":"TAXI", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.30741},
-    {"value":"bus", "baseMode":"BUS", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.20727},
-    {"value":"train", "baseMode":"TRAIN", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.12256},
-    {"value":"free_shuttle", "baseMode":"BUS", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.20727},
-    {"value":"air", "baseMode":"AIR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.09975},
-    {"value":"not_a_trip", "baseMode":"UNKNOWN", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0},
-    {"value":"other", "baseMode":"OTHER", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0}
+    {"value":"walk", "base_mode": "WALKING",
+      "baseMode":"WALKING", "met_equivalent":"WALKING", "kgCo2PerKm": 0},
+    {"value":"bike", "base_mode": "BICYCLING",
+      "baseMode":"BICYCLING", "met_equivalent":"BICYCLING", "kgCo2PerKm": 0},
+    {"value":"scootershare", "base_mode": "E_SCOOTER",
+      "baseMode":"E_SCOOTER", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.00894},
+    {"value":"drove_alone", "base_mode": "CAR",
+      "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.22031},
+    {"value":"shared_ride", "base_mode": "CAR", "passengers": 2,
+      "baseMode":"CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.11015},
+    {"value":"e_car_drove_alone", "base_mode": "E_CAR",
+      "baseMode":"E_CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.08216},
+    {"value":"e_car_shared_ride", "base_mode": "E_CAR", "passengers": 2,
+      "baseMode":"E_CAR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.04108},
+    {"value":"moped", "base_mode": "MOPED",
+      "baseMode":"MOPED", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.05555},
+    {"value":"taxi", "base_mode": "TAXI",
+      "baseMode":"TAXI", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.30741},
+    {"value":"bus", "base_mode": "BUS",
+      "baseMode":"BUS", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.20727},
+    {"value":"train", "base_mode": "TRAIN",
+      "baseMode":"TRAIN", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.12256},
+    {"value":"free_shuttle", "base_mode": "BUS",
+      "baseMode":"BUS", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.20727},
+    {"value":"air", "base_mode": "AIR",
+      "baseMode":"AIR", "met_equivalent":"IN_VEHICLE", "kgCo2PerKm": 0.09975},
+    {"value":"not_a_trip", "base_mode": "NONE",
+      "baseMode":"UNKNOWN", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0},
+    {"value":"other", "base_mode": "OTHER",
+      "baseMode":"OTHER", "met_equivalent":"UNKNOWN", "kgCo2PerKm": 0}
   ],
   "PURPOSE": [
     {"value":"home"},