Trip Departure Choice#

Used in conjuction with Trip Scheduling Choice (Logit Choice), this model chooses departure time periods consistent with the time windows for the appropriate leg of the trip.

Structure#

  • Configuration File: trip_departure_choice.yaml

  • Core Table: trips

  • Result Field: depart

Configuration#

settings activitysim.abm.models.trip_departure_choice.TripDepartureChoiceSettings#

Bases: PydanticCompute

Settings for the trip_departure_choice component.

Config:

  • extra: str = forbid

Fields:
field CONSTANTS: dict[str, Any] = {}#
field PREPROCESSOR: PreprocessorSettings | None = None#

Setting for the preprocessor.

field SPECIFICATION: str = 'trip_departure_choice.csv'#

Filename for the trip departure choice (.csv) file.

field alts_preprocessor: PreprocessorSettings | None = None#

Setting for the alternatives preprocessor.

field compute_settings: ComputeSettings = ComputeSettings(sample_method=None, sharrow_skip=False, fastmath=False, use_bottleneck=None, use_numexpr=None, use_numba=None, drop_unused_columns=True, protect_columns=[], performance_log=None)#

Sharrow settings for this component.

field source_file_paths: list[Path] = None#

A list of source files from which these settings were loaded.

This value should not be set by the user within the YAML settings files, instead it is populated as those files are loaded. It is primarily provided for debugging purposes, and does not actually affect the operation of any model.

Examples#

Implementation#

activitysim.abm.models.trip_departure_choice.trip_departure_choice(state: State, trips: DataFrame, trips_merged: DataFrame, skim_dict: SkimDict | SkimDataset, model_settings: TripDepartureChoiceSettings | None = None, model_settings_file_name: str = 'trip_departure_choice.yaml', trace_label: str = 'trip_departure_choice') → None#