Updated auto sufficiency to be based on number of licensed drivers in the household

Author: wesley-darling

dashboard/pages/tour_summaries/tour_mode.py

@@ -172,8 +172,8 @@ def build_page(self) -> pn.viewable.Viewable:
             **Auto sufficiency definitions**
 
             - **Zero Auto**: household has no vehicles.
-            - **Auto Deficient**: household has fewer vehicles than workers.
-            - **Auto Sufficient**: household has at least as many vehicles as workers.
+            - **Auto Deficient**: household has fewer vehicles than licensed drivers.
+            - **Auto Sufficient**: household has at least as many vehicles as licensed drivers.
             """
             ),
             self._mode_section,

processor/prepare/enrichment/finalize.py

@@ -19,6 +19,7 @@ def _cast_households(hh: pl.DataFrame) -> pl.DataFrame:
             "HHVEH": pl.Int32,
             "HHSIZE": pl.Int32,
             "WORKERS": pl.Int32,
+            "LICENSEDDRIVERS": pl.Int32,
             "ADULTS": pl.Int32,
             "HGEO": pl.Utf8,
         },
@@ -62,6 +63,7 @@ def _cast_tours(tours: pl.DataFrame) -> pl.DataFrame:
             "SKIMDIST": pl.Float64,
             "NUMBER_HH": pl.Int32,
             "AUTOSUFF": pl.Int32,
+            "LICENSEDDRIVERS": pl.Int32,
             "finalweight": pl.Float64,
         },
     )
@@ -89,6 +91,7 @@ def _cast_trips(trips: pl.DataFrame) -> pl.DataFrame:
             "inbound": pl.Int32,
             "trip_num": pl.Int32,
             "AUTOSUFF": pl.Int32,
+            "LICENSEDDRIVERS": pl.Int32,
             "num_participants": pl.Int32,
             "finalweight": pl.Float64,
         },

processor/prepare/enrichment/households_persons.py

@@ -13,6 +13,15 @@
 LOGGER = get_logger("processor.prepare")
 
 
+def _licensed_driver_expr(column_name: str = "has_license") -> pl.Expr:
+    return (
+        pl.col(column_name)
+        .cast(pl.Utf8)
+        .str.to_lowercase()
+        .is_in(["true", "1", "yes", "licensed"])
+    )
+
+
 def _enrich_households(
     state: _PrepareState, config: Config, zone_context: _ZoneContext
 ) -> None:
@@ -142,6 +151,24 @@ def _enrich_persons(
             .alias("imf_choice")
         )
 
+    if {
+        "household_id",
+        "has_license",
+    }.issubset(state.per.columns) and "household_id" in state.hh.columns:
+        licensed_drivers = (
+            state.per.filter(
+                pl.col("household_id").is_not_null() & pl.col("has_license").is_not_null()
+            )
+            .group_by("household_id")
+            .agg(
+                _licensed_driver_expr().sum().cast(pl.Int32).alias("LICENSEDDRIVERS")
+            )
+        )
+        state.hh = (
+            state.hh.join(licensed_drivers, on="household_id", how="left")
+            .with_columns(pl.col("LICENSEDDRIVERS").fill_null(0).cast(pl.Int32))
+        )
+
 
 def _enrich_households_and_persons(
     state: _PrepareState, config: Config, zone_context: _ZoneContext

processor/prepare/enrichment/tours.py

@@ -17,7 +17,7 @@ def _enrich_tours(
 ) -> _PrepareState:
     hh_for_tours = [
         column
-        for column in ["household_id", "HHVEH", "WORKERS", "ADULTS"]
+        for column in ["household_id", "HHVEH", "WORKERS", "LICENSEDDRIVERS", "ADULTS"]
         if column in state.hh.columns
     ]
     if "household_id" in state.tours.columns and "household_id" in hh_for_tours:
@@ -27,13 +27,19 @@ def _enrich_tours(
             how="left",
         )
 
-    if "HHVEH" in state.tours.columns and "WORKERS" in state.tours.columns:
+    if "HHVEH" in state.tours.columns and "LICENSEDDRIVERS" in state.tours.columns:
         state.tours = state.tours.with_columns(
             pl.when(pl.col("HHVEH") == 0)
             .then(0)
-            .when((pl.col("HHVEH") > 0) & (pl.col("HHVEH") < pl.col("WORKERS")))
+            .when(
+                (pl.col("HHVEH") > 0)
+                & (pl.col("HHVEH") < pl.col("LICENSEDDRIVERS"))
+            )
             .then(1)
-            .when((pl.col("HHVEH") > 0) & (pl.col("HHVEH") >= pl.col("WORKERS")))
+            .when(
+                (pl.col("HHVEH") > 0)
+                & (pl.col("HHVEH") >= pl.col("LICENSEDDRIVERS"))
+            )
             .then(2)
             .otherwise(0)
             .alias("AUTOSUFF")

processor/prepare/enrichment/trips.py

@@ -54,7 +54,7 @@ def _enrich_trips(
     if "HHVEH" not in state.trips.columns:
         hh_trip_join_cols = [
             column
-            for column in ["household_id", "HHVEH", "WORKERS"]
+            for column in ["household_id", "HHVEH", "WORKERS", "LICENSEDDRIVERS"]
             if column in state.hh.columns
         ]
         if (
@@ -69,14 +69,20 @@ def _enrich_trips(
     if (
         "AUTOSUFF" not in state.trips.columns
         and "HHVEH" in state.trips.columns
-        and "WORKERS" in state.trips.columns
+        and "LICENSEDDRIVERS" in state.trips.columns
     ):
         state.trips = state.trips.with_columns(
             pl.when(pl.col("HHVEH") == 0)
             .then(0)
-            .when((pl.col("HHVEH") > 0) & (pl.col("HHVEH") < pl.col("WORKERS")))
+            .when(
+                (pl.col("HHVEH") > 0)
+                & (pl.col("HHVEH") < pl.col("LICENSEDDRIVERS"))
+            )
             .then(1)
-            .when((pl.col("HHVEH") > 0) & (pl.col("HHVEH") >= pl.col("WORKERS")))
+            .when(
+                (pl.col("HHVEH") > 0)
+                & (pl.col("HHVEH") >= pl.col("LICENSEDDRIVERS"))
+            )
             .then(2)
             .otherwise(0)
             .alias("AUTOSUFF")

processor/summarize/summaries/tour.py

@@ -219,7 +219,7 @@ def allocated_vehicle_body(rd: RunData, config: Config) -> pl.DataFrame:
         "tour_count_auto_sufficient": pl.Float64,
         "tour_count_all_households": pl.Float64,
     },
-    required_columns={"tours": ("tour_mode", "tour_purpose", "finalweight")},
+    required_columns={"tours": ("tour_mode", "tour_purpose", "finalweight", "AUTOSUFF")},
 )
 def tour_mode(rd: RunData, config: Config) -> pl.DataFrame:
     """Tour mode by auto sufficiency level and total, by tour purpose/category.
@@ -229,7 +229,8 @@ def tour_mode(rd: RunData, config: Config) -> pl.DataFrame:
     tour_count_zero_auto, tour_count_auto_deficient,
     tour_count_auto_sufficient, tour_count_all_households.
     """
-    if "tour_mode" not in rd.tours.columns:
+    required = {"tour_mode", "tour_purpose", "finalweight", "AUTOSUFF"}
+    if not required.issubset(set(rd.tours.columns)):
         return empty_summary_frame(tour_mode)
 
     indiv = (
@@ -280,11 +281,7 @@ def tour_mode(rd: RunData, config: Config) -> pl.DataFrame:
         wgt_col = "wgt" if "wgt" in df.columns else "finalweight"
 
         for as_val in range(3):
-            as_filter = (
-                (pl.col("AUTOSUFF") == as_val)
-                if "AUTOSUFF" in df.columns
-                else pl.lit(True)
-            )
+            as_filter = pl.col("AUTOSUFF") == as_val
 
             sub = df.filter(purpose_filter & as_filter)
             counts = sub.group_by("tour_mode").agg(pl.col(wgt_col).sum().alias("n"))