School Escorting

activitysim/abm/models/__init__.py

@@ -24,6 +24,7 @@
     non_mandatory_scheduling,
     non_mandatory_tour_frequency,
     parking_location_choice,
+    school_escorting,
     stop_frequency,
     summarize,
     tour_mode_choice,

activitysim/abm/models/non_mandatory_destination.py

@@ -7,7 +7,8 @@
 from activitysim.core import config, inject, pipeline, simulate, tracing
 from activitysim.core.util import assign_in_place
 
-from .util import estimation, tour_destination
+from .util import estimation, tour_destination, annotate
+
 
 logger = logging.getLogger(__name__)
 
@@ -43,7 +44,18 @@ def non_mandatory_tour_destination(
     # choosers are tours - in a sense tours are choosing their destination
     non_mandatory_tours = tours[tours.tour_category == "non_mandatory"]
 
-    # - if no mandatory_tours
+    # separating out pure escort school tours
+    # they already have their destination set
+    if pipeline.is_table("school_escort_tours"):
+        nm_tour_index = non_mandatory_tours.index
+        pure_school_escort_tours = non_mandatory_tours[
+            (non_mandatory_tours["school_esc_outbound"] == "pure_escort")
+            | (non_mandatory_tours["school_esc_inbound"] == "pure_escort")
+        ]
+        non_mandatory_tours = non_mandatory_tours[
+            ~non_mandatory_tours.index.isin(pure_school_escort_tours.index)
+        ]
+
     if non_mandatory_tours.shape[0] == 0:
         tracing.no_results(trace_label)
         return
@@ -85,14 +97,27 @@ def non_mandatory_tour_destination(
 
     non_mandatory_tours["destination"] = choices_df.choice
 
+    # merging back in school escort tours and preserving index
+    if pipeline.is_table("school_escort_tours"):
+        non_mandatory_tours = pd.concat(
+            [pure_school_escort_tours, non_mandatory_tours]
+        ).set_index(nm_tour_index)
+
     assign_in_place(tours, non_mandatory_tours[["destination"]])
 
     if want_logsums:
         non_mandatory_tours[logsum_column_name] = choices_df["logsum"]
         assign_in_place(tours, non_mandatory_tours[[logsum_column_name]])
 
+    assert all(
+        ~tours["destination"].isna()
+    ), f"Tours are missing destination: {tours[tours['destination'].isna()]}"
+
     pipeline.replace_table("tours", tours)
 
+    if model_settings.get("annotate_tours"):
+        annotate.annotate_tours(model_settings, trace_label)
+
     if want_sample_table:
         assert len(save_sample_df.index.get_level_values(0).unique()) == len(choices_df)
         # save_sample_df.set_index(model_settings['ALT_DEST_COL_NAME'], append=True, inplace=True)

activitysim/abm/models/non_mandatory_scheduling.py

@@ -8,10 +8,7 @@
 from activitysim.core import timetable as tt
 from activitysim.core import tracing
 from activitysim.core.util import assign_in_place
-
-from .util import estimation
 from .util.tour_scheduling import run_tour_scheduling
-from .util.vectorize_tour_scheduling import vectorize_tour_scheduling
 
 logger = logging.getLogger(__name__)
 DUMP = False

activitysim/abm/models/non_mandatory_tour_frequency.py

@@ -17,6 +17,9 @@
 from activitysim.core.interaction_simulate import interaction_simulate
 
 from .util import estimation
+from .util import annotate
+from .util.school_escort_tours_trips import recompute_tour_count_statistics
+
 from .util.overlap import person_max_window
 from .util.tour_frequency import process_non_mandatory_tours
 
@@ -376,6 +379,13 @@ def non_mandatory_tour_frequency(persons, persons_merged, chunk_size, trace_hh_i
     tracing.register_traceable_table("tours", non_mandatory_tours)
     pipeline.get_rn_generator().add_channel("tours", non_mandatory_tours)
 
+    if pipeline.is_table("school_escort_tours"):
+        # need to re-compute tour frequency statistics to account for school escort tours
+        recompute_tour_count_statistics()
+
+    if model_settings.get("annotate_tours"):
+        annotate.annotate_tours(model_settings, trace_label)
+
     expressions.assign_columns(
         df=persons,
         model_settings=model_settings.get("annotate_persons"),