Changes on generic_metric and mode_specific_metrics in relation to Mo…

frontend/index.html

@@ -374,8 +374,22 @@
 					const STUDY_CONFIG = _getStudyName(window.location);
 					$.getJSON('https://raw.githubusercontent.com/e-mission/nrel-openpath-deploy-configs/main/configs/' + STUDY_CONFIG + '.nrel-op.json', function(data) {
 						// Load list of plots corresponding to study/program
-						if (data.intro.program_or_study=='program') {
-                            $.get("metrics_program.html", function(response) {
+						dynamic_labels = data.label_options
+						if (data.intro.program_or_study=='program')
+						{
+							// Note: We're disabling energy metrics on public dashboard when dynamic labels are available.
+							// TODO: Remove the if (data.label_options) in future when energy computation is handled properly.
+							if (dynamic_labels)
+							{
+								load_file = "metrics_program_withoutEnergyMetrics.html"
+								console.log("Dynamic Labels are available for: " + STUDY_CONFIG)
+							}
+							else
+							{
+								load_file = "metrics_program_withoutEnergyMetrics.html"
+								console.log("Dynamic Labels are unavailable for: " + STUDY_CONFIG)
+							}
+							$.get(load_file, function(response) {
                                 const configuredResponse = response.replaceAll("${data.intro.mode_studied}", data.intro.mode_studied);
                                 $('#metric').append(configuredResponse);
                                 addPreconfiguredMetrics([
@@ -387,19 +401,30 @@
                                     `ntrips_${data.intro.mode_studied}_per_weekday`,
                                     `sketch_CO2impact_${data.intro.mode_studied}`
                                 ]);
-                            });
-						} else {
-							$('#metric').load('metrics_study.html');
-                            addPreconfiguredMetrics([
-                                "ntrips_mode_confirm",
-                                "miles_mode_confirm",
-                                "ntrips_sensed_mode",
-                                "miles_sensed_mode",
-                                "ntrips_purpose",
-                                "ntrips_sensed_per_weekday",
-                                "ts_emissions_user"
-                            ]);
-						};
+                            	});
+						} 
+						else  // CASE: STUDY
+						{
+							if (dynamic_labels)
+							{
+								console.log("Dynamic Labels are available for: " + STUDY_CONFIG)
+								$('#metric').load('metrics_study_withoutEnergyMetrics.html');
+							}
+							else
+							{
+								console.log("Dynamic Labels are unavailable for: " + STUDY_CONFIG)
+								$('#metric').load('metrics_study.html');
+							};
+							addPreconfiguredMetrics([
+								"ntrips_mode_confirm",
+								"miles_mode_confirm",
+								"ntrips_sensed_mode",
+								"miles_sensed_mode",
+								"ntrips_purpose",
+								"ntrips_sensed_per_weekday",
+								"ts_emissions_user"
+							]);
+						}
                         // Figure out all months since start date to present
                         var date_options = "<option value=''>All data</option>";
                         const dates = getMonthList(

frontend/metrics_program_withoutEnergyMetrics.html

@@ -0,0 +1,36 @@
+<!-- Replica of metrics_program.html without energy options-->
+<!-- Generic -->
+<option value="ntrips_mode_confirm" data-sizex="4" data-sizey="4">Number of trips</option>
+<option value="ntrips_commute_mode_confirm" data-sizex="4" data-sizey="4">Number of commute trips</option>
+<option value="ntrips_sensed_mode" data-sizex="4" data-sizey="4">Number of trips (sensed)</option>
+<option value="ntrips_purpose" data-sizex="4" data-sizey="4">Trip count by purpose</option>
+<option value="ntrips_under10miles_mode_confirm" data-sizex="4" data-sizey="4">Trip count under 10 miles</option>
+<option value="ntrips_under10miles_sensed_mode" data-sizex="4" data-sizey="4">Trip count under 10 miles (sensed)</option>
+<option value="miles_mode_confirm" data-sizex="4" data-sizey="4">Trip miles by mode</option>
+<option value="miles_sensed_mode" data-sizex="4" data-sizey="4">Trip miles by mode</option>
+<option value="miles_sensed_mode_land" data-sizex="4" data-sizey="4">Trip miles by land mode (sensed)</option>
+<option value="average_miles_mode_confirm" data-sizex="6" data-sizey="4">Average trip length</option>
+<option value="average_miles_sensed_mode" data-sizex="6" data-sizey="4">Average trip length (sensed)</option>
+<option value="average_miles_mode_confirm2" data-sizex="6" data-sizey="4">Average trip length (selected by users)</option>
+<option value="ntrips_per_day" data-sizex="6" data-sizey="4">Trip frequency</option>
+<option value="ntrips_sensed_per_day" data-sizex="6" data-sizey="4">Trip frequency (sensed)</option>
+<option value="ntrips_per_weekday" data-sizex="6" data-sizey="4">Trip frequency (weekday)</option>
+<option value="ntrips_sensed_per_weekday" data-sizex="6" data-sizey="4">Trip frequency (weekday, sensed)</option>
+<option value="ts_emissions_user" data-sizex="8" data-sizey="2">Timeseries of emissions</option>
+<option value="ts_emissions_vmt" data-sizex="8" data-sizey="2">Timeseries of emissions per kilometer</option>
+<option value="ts_users" data-sizex="8" data-sizey="2">Timeseries of active users</option>
+<option value="ts_all_modes" data-sizex="8" data-sizey="2">Timeseries of all mode shares</option>
+<!-- Mode Specific -->
+<option value="ntrips_${data.intro.mode_studied}_purpose" data-sizex="4" data-sizey="4">`${data.intro.mode_studied}` specific trip count by purpose</option>
+<option value="miles_${data.intro.mode_studied}_replaced_mode" data-sizex="4" data-sizey="4">`${data.intro.mode_studied}` specific trip miles by replaced mode</option>
+<option value="average_miles_replaced_mode" data-sizex="4" data-sizey="4">Average Miles for each replaced mode (w/Other)</option>
+<option value="ntrips_${data.intro.mode_studied}_per_day" data-sizex="6" data-sizey="4">`${data.intro.mode_studied}` specific Trip frequency</option>
+<option value="ntrips_${data.intro.mode_studied}_per_weekday" data-sizex="6" data-sizey="4">`${data.intro.mode_studied}` specific Trips per weekday</option>
+<option value="sketch_CO2impact_${data.intro.mode_studied}" data-sizex="6" data-sizey="4">Sketch of `${data.intro.mode_studied}` specific emission impact</option>
+<option value="ts_${data.intro.mode_studied}_share" data-sizex="8" data-sizey="2">Timeseries of `${data.intro.mode_studied}` specific trips</option>
+<option value="ts_${data.intro.mode_studied}_miles" data-sizex="8" data-sizey="2">Timeseries of `${data.intro.mode_studied}` specific milage</option>
+<option value="ts_${data.intro.mode_studied}_miles_user" data-sizex="8" data-sizey="2">Timeseries of `${data.intro.mode_studied}` specific milage per user</option>
+<option value="ts_${data.intro.mode_studied}_miles_proportion" data-sizex="8" data-sizey="2">Timeseries of proportion of `${data.intro.mode_studied}` specific miles</option>
+<option value="ts_${data.intro.mode_studied}_trips_proportion" data-sizex="8" data-sizey="2">Timeseries of mileage per user</option>
+<option value="ts_${data.intro.mode_studied}_trip_individual_variation" data-sizex="8" data-sizey="2">`${data.intro.mode_studied}` specific trip variation over time</option>
+<option value="ts_${data.intro.mode_studied}_mile_individual_variation" data-sizex="8" data-sizey="2">`${data.intro.mode_studied}` specific mileage variation over time</option>

frontend/metrics_study_withoutEnergyMetrics.html

@@ -0,0 +1,22 @@
+<!-- Replica of metrics_study.html without energy option-->
+<!-- Generic -->
+<option value="ntrips_mode_confirm" data-sizex="4" data-sizey="4">Number of trips</option>
+<option value="ntrips_commute_mode_confirm" data-sizex="4" data-sizey="4">Number of commute trips</option>
+<option value="ntrips_sensed_mode" data-sizex="4" data-sizey="4">Number of trips (sensed)</option>
+<option value="ntrips_purpose" data-sizex="4" data-sizey="4">Trip count by purpose</option>
+<option value="ntrips_under10miles_mode_confirm" data-sizex="4" data-sizey="4">Trip count under 10 miles</option>
+<option value="ntrips_under10miles_sensed_mode" data-sizex="4" data-sizey="4">Trip count under 10 miles (sensed)</option>
+<option value="miles_mode_confirm" data-sizex="4" data-sizey="4">Trip miles by mode</option>
+<option value="miles_sensed_mode" data-sizex="4" data-sizey="4">Trip miles by mode (sensed)</option>
+<option value="miles_sensed_mode_land" data-sizex="4" data-sizey="4">Trip miles by land mode (sensed)</option>
+<option value="average_miles_mode_confirm" data-sizex="6" data-sizey="4">Average trip length</option>
+<option value="average_miles_sensed_mode" data-sizex="6" data-sizey="4">Average trip length (sensed)</option>
+<option value="average_miles_mode_confirm2" data-sizex="6" data-sizey="4">Average trip length (selected by users)</option>
+<option value="ntrips_per_day" data-sizex="6" data-sizey="4">Trip frequency</option>
+<option value="ntrips_sensed_per_day" data-sizex="6" data-sizey="4">Trip frequency (sensed)</option>
+<option value="ntrips_per_weekday" data-sizex="6" data-sizey="4">Trip frequency (weekday)</option>
+<option value="ntrips_sensed_per_weekday" data-sizex="6" data-sizey="4">Trip frequency (weekday, sensed)</option>
+<option value="ts_emissions_user" data-sizex="8" data-sizey="2">Timeseries of emissions</option>
+<option value="ts_emissions_vmt" data-sizex="8" data-sizey="2">Timeseries of emissions per kilometer</option>
+<option value="ts_users" data-sizex="8" data-sizey="2">Timeseries of active users</option>
+<option value="ts_all_modes" data-sizex="8" data-sizey="2">Timeseries of all mode shares</option>

viz_scripts/bin/generate_plots.py

@@ -34,13 +34,31 @@
     dynamic_config = json.loads(r.text)
     print(f"Successfully downloaded config with version {dynamic_config['version']} "\
         f"for {dynamic_config['intro']['translated_text']['en']['deployment_name']} "\
-        f"and data collection URL {dynamic_config['server']['connectUrl']}")
+        f"and data collection URL {dynamic_config['server']['connectUrl'] if 'server' in dynamic_config else 'default'}")
 
 if dynamic_config['intro']['program_or_study'] == 'program':
     mode_studied = dynamic_config['intro']['mode_studied']
 else:
     mode_studied = None
 
+# dynamic_labels can  be referenced from 
+# https://github.com/e-mission/nrel-openpath-deploy-configs/blob/main/label_options/example-study-label-options.json
+dynamic_labels = { }
+
+# Check if the dynamic config contains dynamic labels 'label_options'
+# Parse through the dynamic_labels_url:
+if 'label_options' in dynamic_config:
+    dynamic_labels_url = dynamic_config['label_options']
+
+    req = requests.get(dynamic_labels_url)
+    if req.status_code != 200:
+        print(f"Unable to download dynamic_labels_url, status code: {req.status_code} for {STUDY_CONFIG}")
+    else:
+        dynamic_labels = json.loads(req.text)
+        print(f"Dynamic labels download was successful for nrel-openpath-deploy-configs: {STUDY_CONFIG}" )
+else:
+    print(f"label_options is unavailable for the dynamic_config in {STUDY_CONFIG}")
+
 if args.date is None:
     start_date = arrow.get(int(dynamic_config['intro']['start_year']),
         int(dynamic_config['intro']['start_month']), 1)
@@ -70,6 +88,7 @@ def compute_for_date(month, year):
         study_type=dynamic_config['intro']['program_or_study'],
         mode_of_interest=mode_studied,
         include_test_users=dynamic_config.get('metrics', {}).get('include_test_users', False),
+        dynamic_labels = dynamic_labels,
         sensed_algo_prefix=dynamic_config.get('metrics', {}).get('sensed_algo_prefix', "cleaned"))
 
     print(f"Running at {arrow.get()} with params {params}")

viz_scripts/energy_calculations.ipynb

@@ -30,7 +30,9 @@
     "program = \"default\"\n",
     "study_type = \"program\"\n",
     "mode_of_interest = \"e-bike\"\n",
-    "include_test_users = False"
+    "include_test_users = False\n",
+    "is_debug_mode = False\n",
+    "dynamic_labels = {}"
    ]
   },
   {
@@ -107,11 +109,12 @@
     "                                                                            month,\n",
     "                                                                            program,\n",
     "                                                                            study_type,\n",
+    "                                                                            dynamic_labels,\n",
     "                                                                            dic_re,\n",
     "                                                                            dic_pur=dic_pur,\n",
     "                                                                            include_test_users=include_test_users)\n",
     "# CASE 1 of https://github.com/e-mission/em-public-dashboard/issues/69#issuecomment-1256835867 \n",
-    "expanded_ct = scaffolding.add_energy_impact(expanded_ct, df_ei, dic_fuel) if len(expanded_ct) > 0 else expanded_ct"
+    "expanded_ct = scaffolding.add_energy_impact(expanded_ct, df_ei, dic_fuel, dynamic_labels) if len(expanded_ct) > 0 else expanded_ct"
    ]
   },
   {
@@ -212,27 +215,73 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_title_no_quality=f\"Sketch of Total Pounds of CO2 Emissions of {mode_of_interest} trips\"\n",
-    "file_name =f'sketch_CO2impact_{mode_of_interest}%s' % file_suffix\n",
+    "#  Case: label_options is present on the config file\n",
+    "if len(dynamic_labels) > 0:\n",
+    "    plot_title_no_quality=f\"Sketch of Total Kilograms of CO2 Emissions of {mode_of_interest} trips\"\n",
+    "    file_name =f'sketch_CO2impact_{mode_of_interest}%s' % file_suffix\n",
     "\n",
-    "try:\n",
-    "    ebco2=data_eb.groupby('Replaced_mode').agg({'CO2_Impact(lb)': ['sum', 'mean']},)\n",
-    "    ebco2.columns = ['total_lb_CO2_emissions', 'average_lb_CO2_emission']\n",
-    "    ebco2 = ebco2.reset_index()\n",
-    "    ebco2 = ebco2.sort_values(by=['total_lb_CO2_emissions'], ascending=False)\n",
-    "    ebco2['boolean'] = ebco2['total_lb_CO2_emissions'] > 0\n",
-    "    net_CO2_emissions = round(sum(ebco2['total_lb_CO2_emissions']), 2)\n",
+    "    try:\n",
+    "        ebco2=data_eb.groupby('Replaced_mode').agg({'CO2_Impact(kg)': ['sum', 'mean']},)\n",
+    "        ebco2.columns = ['total_kg_CO2_emissions', 'average_kg_CO2_emission']\n",
+    "        ebco2 = ebco2.reset_index()\n",
+    "        ebco2 = ebco2.sort_values(by=['total_kg_CO2_emissions'], ascending=False)\n",
+    "        ebco2['boolean'] = ebco2['total_kg_CO2_emissions'] > 0\n",
+    "        net_CO2_emissions = round(sum(ebco2['total_kg_CO2_emissions']), 2)\n",
     "\n",
-    "    x = ebco2['total_lb_CO2_emissions']\n",
-    "    y = ebco2['Replaced_mode']\n",
-    "    color = ebco2['boolean']\n",
+    "        x = ebco2['total_kg_CO2_emissions']\n",
+    "        y = ebco2['Replaced_mode']\n",
+    "        xLabel = 'CO2 Emissions (kg)'\n",
+    "        yLabel = 'Replaced Mode'\n",
+    "        color = ebco2['boolean']\n",
     "\n",
-    "    plot_title= plot_title_no_quality+f\"\\n Contribution by replaced mode towards a total of {net_CO2_emissions}(lb CO2 Emissions )\\n\"+quality_text\n",
-    "    CO2_impact(x,y,color,plot_title,file_name)\n",
-    "    alt_text = store_alt_text_bar(pd.DataFrame(x.values,y), file_name, plot_title)\n",
-    "except:\n",
-    "    generate_missing_plot(plot_title_no_quality,debug_df,file_name)\n",
-    "    alt_text = store_alt_text_missing(debug_df, file_name, plot_title_no_quality)"
+    "        plot_title= plot_title_no_quality+f\"\\n Contribution by replaced mode towards a total of {net_CO2_emissions}(kg CO2 Emissions )\\n\"+quality_text\n",
+    "        CO2_impact(x,y,color,plot_title, xLabel,yLabel,file_name)\n",
+    "        alt_text = store_alt_text_bar(pd.DataFrame(x.values,y), file_name, plot_title)\n",
+    "        \n",
+    "        if (is_debug_mode == True):\n",
+    "            ebco2_lb=data_eb.groupby('Replaced_mode').agg({'CO2_Impact(lb)': ['sum', 'mean']},)\n",
+    "            ebco2_lb.columns = ['total_lb_CO2_emissions', 'average_lb_CO2_emission']\n",
+    "            ebco2_lb = ebco2_lb.reset_index()\n",
+    "            ebco2_lb = ebco2_lb.sort_values(by=['total_lb_CO2_emissions'], ascending=False)\n",
+    "            \n",
+    "            scaffolding.print_CO2_emission_calculations(data_eb, ebco2_lb, ebco2, dynamic_labels)\n",
+    "     \n",
+    "    except:\n",
+    "        generate_missing_plot(plot_title_no_quality,debug_df,file_name)\n",
+    "        alt_text = store_alt_text_missing(debug_df, file_name, plot_title_no_quality)\n",
+    "# case: when label_options is absent from the config file\n",
+    "else: \n",
+    "    plot_title_no_quality=f\"Sketch of Total pounds of CO2 Emissions of {mode_of_interest} trips\"\n",
+    "    file_name =f'sketch_CO2impact_{mode_of_interest}%s' % file_suffix\n",
+    "\n",
+    "    try:\n",
+    "        ebco2=data_eb.groupby('Replaced_mode').agg({'CO2_Impact(lb)': ['sum', 'mean']},)\n",
+    "        ebco2.columns = ['total_lb_CO2_emissions', 'average_lb_CO2_emission']\n",
+    "        ebco2 = ebco2.reset_index()\n",
+    "        ebco2 = ebco2.sort_values(by=['total_lb_CO2_emissions'], ascending=False)\n",
+    "        ebco2['boolean'] = ebco2['total_lb_CO2_emissions'] > 0\n",
+    "        net_CO2_emissions = round(sum(ebco2['total_lb_CO2_emissions']), 2)\n",
+    "\n",
+    "        x = ebco2['total_lb_CO2_emissions']\n",
+    "        y = ebco2['Replaced_mode']\n",
+    "        xLabel = 'CO2 Emissions (lb)'\n",
+    "        yLabel = 'Replaced Mode'\n",
+    "        color = ebco2['boolean']\n",
+    "\n",
+    "        plot_title= plot_title_no_quality+f\"\\n Contribution by replaced mode towards a total of {net_CO2_emissions}(lb CO2 Emissions )\\n\"+quality_text\n",
+    "        CO2_impact(x,y,color,plot_title,xLabel,yLabel,file_name)\n",
+    "        alt_text = store_alt_text_bar(pd.DataFrame(x.values,y), file_name, plot_title)\n",
+    "\n",
+    "        if (is_debug_mode == True):\n",
+    "            ebco2_kg=data_eb.groupby('Replaced_mode').agg({'CO2_Impact(kg)': ['sum', 'mean']},)\n",
+    "            ebco2_kg.columns = ['total_kg_CO2_emissions', 'average_kg_CO2_emission']\n",
+    "            ebco2_kg = ebco2_kg.reset_index()\n",
+    "            ebco2_kg = ebco2_kg.sort_values(by=['total_kg_CO2_emissions'], ascending=False)\n",
+    "            \n",
+    "            scaffolding.print_CO2_emission_calculations(data_eb, ebco2, ebco2_kg, dynamic_labels)\n",
+    "    except:\n",
+    "        generate_missing_plot(plot_title_no_quality,debug_df,file_name)\n",
+    "        alt_text = store_alt_text_missing(debug_df, file_name, plot_title_no_quality)"
    ]
   }
  ],