Created SegmentedSpecificationError for when there's an issue with a spec table that's created for a specific segment

Author: JoeJimFlood

activitysim/abm/models/trip_departure_choice.py

@@ -27,6 +27,7 @@
 from activitysim.core.skim_dataset import SkimDataset
 from activitysim.core.skim_dictionary import SkimDict
 from activitysim.core.util import reindex
+from activitysim.core.exceptions import SegmentedSpecificationError
 
 logger = logging.getLogger(__name__)
 
@@ -219,7 +220,7 @@ def choose_tour_leg_pattern(
         )
 
     if len(spec.columns) > 1:
-        raise RuntimeError("spec must have only one column")
+        raise SegmentedSpecificationError("spec must have only one column")
 
     # - join choosers and alts
     # in vanilla interaction_simulate interaction_df is cross join of choosers and alternatives

activitysim/core/exceptions.py

@@ -78,4 +78,7 @@ class InputPopulationError(RuntimeError):
     """An issue with the input population was found."""
 
 class SubprocessError(RuntimeError):
-    """An error occurred in a subprocess."""
+    """An error occurred in a subprocess."""
+
+class SegmentedSpecificationError(RuntimeError):
+    """An error was caused by creating an invalid spec table for a segmented model component."""

activitysim/core/interaction_sample.py

@@ -20,6 +20,7 @@
 from activitysim.core.configuration.base import ComputeSettings
 from activitysim.core.skim_dataset import DatasetWrapper
 from activitysim.core.skim_dictionary import SkimWrapper
+from activitysim.core.exceptions import SegmentedSpecificationError
 
 logger = logging.getLogger(__name__)
 
@@ -219,7 +220,7 @@ def _interaction_sample(
         )
 
     if len(spec.columns) > 1:
-        raise RuntimeError("spec must have only one column")
+        raise SegmentedSpecificationError("spec must have only one column")
 
     # if using skims, copy index into the dataframe, so it will be
     # available as the "destination" for set_skim_wrapper_targets

activitysim/core/interaction_sample_simulate.py

@@ -10,6 +10,7 @@
 from activitysim.core import chunk, interaction_simulate, logit, tracing, util, workflow
 from activitysim.core.configuration.base import ComputeSettings
 from activitysim.core.simulate import set_skim_wrapper_targets
+from activitysim.core.exceptions import SegmentedSpecificationError
 
 logger = logging.getLogger(__name__)
 
@@ -115,7 +116,7 @@ def _interaction_sample_simulate(
         )
 
     if len(spec.columns) > 1:
-        raise RuntimeError("spec must have only one column")
+        raise SegmentedSpecificationError("spec must have only one column")
 
     # if using skims, copy index into the dataframe, so it will be
     # available as the "destination" for the skims dereference below

activitysim/core/interaction_simulate.py

@@ -16,6 +16,7 @@
 from activitysim.core import chunk, logit, simulate, timing, tracing, util, workflow
 from activitysim.core.configuration.base import ComputeSettings
 from activitysim.core.fast_eval import fast_eval
+from activitysim.core.exceptions import SegmentedSpecificationError
 
 logger = logging.getLogger(__name__)
 
@@ -722,7 +723,7 @@ def _interaction_simulate(
         )
 
     if len(spec.columns) > 1:
-        raise RuntimeError("spec must have only one column")
+        raise SegmentedSpecificationError("spec must have only one column")
 
     sample_size = sample_size or len(alternatives)