Components

• Initialize
  • Implementation
    • initialize_landuse()
    • initialize_households()
• Initialize LOS
  • Implementation
    • initialize_los()
    • compute_utilities_for_attribute_tuple()
    • initialize_tvpb()
• Initialize Tours
  • Implementation
    • initialize_tours()
• Accessibility
  • Structure
  • Configuration
    • AccessibilitySettings
      • AccessibilitySettings.CONSTANTS
      • AccessibilitySettings.SPEC
      • AccessibilitySettings.explicit_chunk
      • AccessibilitySettings.land_use_columns
      • AccessibilitySettings.land_use_columns_orig
    • Examples
  • Implementation
    • compute_accessibility()
• Auto Ownership
  • Structure
  • Configuration
    • AutoOwnershipSettings
      • AutoOwnershipSettings.COEFFICIENTS
      • AutoOwnershipSettings.CONSTANTS
      • AutoOwnershipSettings.LOGIT_TYPE
      • AutoOwnershipSettings.NESTS
      • AutoOwnershipSettings.SPEC
      • AutoOwnershipSettings.annotate_households
      • AutoOwnershipSettings.compute_settings
      • AutoOwnershipSettings.preprocessor
      • AutoOwnershipSettings.source_file_paths
      • AutoOwnershipSettings.nests_are_for_nl()
      • AutoOwnershipSettings.update_sharrow_skip
    • Examples
  • Implementation
    • auto_ownership_simulate()
• Vehicle Type Choice
  • Structure
  • Configuration
    • VehicleTypeChoiceSettings
      • VehicleTypeChoiceSettings.COEFFICIENTS
      • VehicleTypeChoiceSettings.COLS_TO_INCLUDE_IN_ALTS_TABLE
      • VehicleTypeChoiceSettings.COLS_TO_INCLUDE_IN_CHOOSER_TABLE
      • VehicleTypeChoiceSettings.COLS_TO_INCLUDE_IN_VEHICLE_TABLE
      • VehicleTypeChoiceSettings.CONSTANTS
      • VehicleTypeChoiceSettings.FLEET_YEAR
      • VehicleTypeChoiceSettings.LOGIT_TYPE
      • VehicleTypeChoiceSettings.NESTS
      • VehicleTypeChoiceSettings.PROBS_SPEC
      • VehicleTypeChoiceSettings.REQUIRE_DATA_FOR_ALL_ALTS
      • VehicleTypeChoiceSettings.SIMULATION_TYPE
      • VehicleTypeChoiceSettings.SPEC
      • VehicleTypeChoiceSettings.VEHICLE_TYPE_DATA_FILE
      • VehicleTypeChoiceSettings.WRITE_OUT_ALTS_FILE
      • VehicleTypeChoiceSettings.alts_preprocessor
      • VehicleTypeChoiceSettings.annotate_households
      • VehicleTypeChoiceSettings.annotate_persons
      • VehicleTypeChoiceSettings.annotate_vehicles
      • VehicleTypeChoiceSettings.combinatorial_alts
      • VehicleTypeChoiceSettings.compute_settings
      • VehicleTypeChoiceSettings.explicit_chunk
      • VehicleTypeChoiceSettings.preprocessor
      • VehicleTypeChoiceSettings.source_file_paths
      • VehicleTypeChoiceSettings.nests_are_for_nl()
      • VehicleTypeChoiceSettings.update_sharrow_skip
    • Examples
  • Implementation
    • vehicle_type_choice()
    • append_probabilistic_vehtype_type_choices()
    • annotate_vehicle_type_choice_households()
    • annotate_vehicle_type_choice_persons()
    • annotate_vehicle_type_choice_vehicles()
    • get_combinatorial_vehicle_alternatives()
    • construct_model_alternatives()
    • get_vehicle_type_data()
    • iterate_vehicle_type_choice()
• Telecommute Frequency
  • Structure
  • Configuration
    • TelecommuteFrequencySettings
      • TelecommuteFrequencySettings.COEFFICIENTS
      • TelecommuteFrequencySettings.CONSTANTS
      • TelecommuteFrequencySettings.LOGIT_TYPE
      • TelecommuteFrequencySettings.NESTS
      • TelecommuteFrequencySettings.SPEC
      • TelecommuteFrequencySettings.compute_settings
      • TelecommuteFrequencySettings.preprocessor
      • TelecommuteFrequencySettings.source_file_paths
      • TelecommuteFrequencySettings.nests_are_for_nl()
      • TelecommuteFrequencySettings.update_sharrow_skip
    • Examples
  • Implementation
    • telecommute_frequency()
• Coordinated Daily Activity Pattern
  • Structure
  • Configuration
    • CdapSettings
      • CdapSettings.ADD_JOINT_TOUR_UTILITY
      • CdapSettings.COEFFICIENTS
      • CdapSettings.CONSTANTS
      • CdapSettings.FIXED_RELATIVE_PROPORTIONS_SPEC
      • CdapSettings.INDIV_AND_HHSIZE1_SPEC
      • CdapSettings.INTERACTION_COEFFICIENTS
      • CdapSettings.JOINT_TOUR_COEFFICIENTS
      • CdapSettings.JOINT_TOUR_USEFUL_COLUMNS
      • CdapSettings.PERSON_TYPE_MAP
      • CdapSettings.annotate_households
      • CdapSettings.annotate_persons
      • CdapSettings.compute_settings
    • Examples
  • Implementation
    • cdap_simulate()
• Mandatory Tour Frequency
  • Structure
  • Configuration
    • MandatoryTourFrequencySettings
      • MandatoryTourFrequencySettings.COEFFICIENTS
      • MandatoryTourFrequencySettings.CONSTANTS
      • MandatoryTourFrequencySettings.LOGIT_TYPE
      • MandatoryTourFrequencySettings.NESTS
      • MandatoryTourFrequencySettings.SPEC
      • MandatoryTourFrequencySettings.annotate_persons
      • MandatoryTourFrequencySettings.compute_settings
      • MandatoryTourFrequencySettings.preprocessor
      • MandatoryTourFrequencySettings.source_file_paths
      • MandatoryTourFrequencySettings.nests_are_for_nl()
      • MandatoryTourFrequencySettings.update_sharrow_skip
    • Examples
  • Implementation
    • mandatory_tour_frequency()
• School Escorting
  • Configuration
    • SchoolEscortSettings
      • SchoolEscortSettings.AGE_COLUMN
      • SchoolEscortSettings.AGE_WEIGHT
      • SchoolEscortSettings.ALTS
      • SchoolEscortSettings.CHAPERONE_AGE_CUTOFF
      • SchoolEscortSettings.COEFFICIENTS
      • SchoolEscortSettings.CONSTANTS
      • SchoolEscortSettings.ESCORTEE_AGE_CUTOFF
      • SchoolEscortSettings.GENDER_COLUMN
      • SchoolEscortSettings.GENDER_WEIGHT
      • SchoolEscortSettings.INBOUND_COEFFICIENTS
      • SchoolEscortSettings.INBOUND_SPEC
      • SchoolEscortSettings.LOGIT_TYPE
      • SchoolEscortSettings.NUM_CHAPERONES
      • SchoolEscortSettings.NUM_ESCORTEES
      • SchoolEscortSettings.OUTBOUND_COEFFICIENTS
      • SchoolEscortSettings.OUTBOUND_COND_COEFFICIENTS
      • SchoolEscortSettings.OUTBOUND_COND_SPEC
      • SchoolEscortSettings.OUTBOUND_SPEC
      • SchoolEscortSettings.PERSONTYPE_COLUMN
      • SchoolEscortSettings.PERSON_WEIGHT
      • SchoolEscortSettings.SIMULATE_CHOOSER_COLUMNS
      • SchoolEscortSettings.SPEC
      • SchoolEscortSettings.compute_settings
      • SchoolEscortSettings.explicit_chunk
      • SchoolEscortSettings.no_escorting_alterative
      • SchoolEscortSettings.preprocessor
      • SchoolEscortSettings.preprocessor_inbound
      • SchoolEscortSettings.preprocessor_outbound
      • SchoolEscortSettings.preprocessor_outbound_cond
      • SchoolEscortSettings.update_sharrow_skip
    • Examples
  • Implementation
    • school_escorting()
• Joint Tour Composition
  • Structure
  • Configuration
    • JointTourCompositionSettings
      • JointTourCompositionSettings.COEFFICIENTS
      • JointTourCompositionSettings.CONSTANTS
      • JointTourCompositionSettings.LOGIT_TYPE
      • JointTourCompositionSettings.NESTS
      • JointTourCompositionSettings.SPEC
      • JointTourCompositionSettings.compute_settings
      • JointTourCompositionSettings.preprocessor
      • JointTourCompositionSettings.source_file_paths
      • JointTourCompositionSettings.nests_are_for_nl()
      • JointTourCompositionSettings.update_sharrow_skip
    • Examples
  • Implementation
    • joint_tour_composition()
• Joint Tour Participation
  • Structure
  • Configuration
    • JointTourParticipationSettings
      • JointTourParticipationSettings.COEFFICIENTS
      • JointTourParticipationSettings.CONSTANTS
      • JointTourParticipationSettings.FORCE_PARTICIPATION
      • JointTourParticipationSettings.LOGIT_TYPE
      • JointTourParticipationSettings.NESTS
      • JointTourParticipationSettings.SPEC
      • JointTourParticipationSettings.annotate_persons
      • JointTourParticipationSettings.compute_settings
      • JointTourParticipationSettings.max_participation_choice_iterations
      • JointTourParticipationSettings.participation_choice
      • JointTourParticipationSettings.preprocessor
      • JointTourParticipationSettings.source_file_paths
      • JointTourParticipationSettings.nests_are_for_nl()
      • JointTourParticipationSettings.update_sharrow_skip
    • Examples
  • Implementation
    • joint_tour_participation()
    • participants_chooser()
• Joint Tour Destination
  • Structure
  • Configuration
    • TourLocationComponentSettings
      • TourLocationComponentSettings.ALT_DEST_COL_NAME
      • TourLocationComponentSettings.CHOOSER_FILTER_COLUMN_NAME
      • TourLocationComponentSettings.CHOOSER_ID_COLUMN
      • TourLocationComponentSettings.CHOOSER_ORIG_COL_NAME
      • TourLocationComponentSettings.CHOOSER_SEGMENT_COLUMN_NAME
      • TourLocationComponentSettings.CHOOSER_TABLE_NAME
      • TourLocationComponentSettings.COEFFICIENTS
      • TourLocationComponentSettings.CONSTANTS
      • TourLocationComponentSettings.DEST_CHOICE_COLUMN_NAME
      • TourLocationComponentSettings.DEST_CHOICE_LOGSUM_COLUMN_NAME
      • TourLocationComponentSettings.DEST_CHOICE_SAMPLE_TABLE_NAME
      • TourLocationComponentSettings.ESTIMATION_SAMPLE_SIZE
      • TourLocationComponentSettings.IN_PERIOD
      • TourLocationComponentSettings.LOGSUM_PREPROCESSOR
      • TourLocationComponentSettings.LOGSUM_SETTINGS
      • TourLocationComponentSettings.LOGSUM_TOUR_PURPOSE
      • TourLocationComponentSettings.MODELED_SIZE_TABLE
      • TourLocationComponentSettings.MODEL_SELECTOR
      • TourLocationComponentSettings.MODE_CHOICE_LOGSUM_COLUMN_NAME
      • TourLocationComponentSettings.ORIG_ZONE_ID
      • TourLocationComponentSettings.OUT_PERIOD
      • TourLocationComponentSettings.SAMPLE_SIZE
      • TourLocationComponentSettings.SAMPLE_SPEC
      • TourLocationComponentSettings.SAVED_SHADOW_PRICE_TABLE_NAME
      • TourLocationComponentSettings.SEGMENTS
      • TourLocationComponentSettings.SEGMENT_IDS
      • TourLocationComponentSettings.SHADOW_PRICE_TABLE
      • TourLocationComponentSettings.SIMULATE_CHOOSER_COLUMNS
      • TourLocationComponentSettings.SIZE_TERM_SELECTOR
      • TourLocationComponentSettings.SPEC
      • TourLocationComponentSettings.annotate_households
      • TourLocationComponentSettings.annotate_persons
      • TourLocationComponentSettings.annotate_tours
      • TourLocationComponentSettings.compute_settings
      • TourLocationComponentSettings.explicit_chunk
      • TourLocationComponentSettings.source_file_paths
      • TourLocationComponentSettings.update_sharrow_skip
    • Examples
  • Implementation
    • joint_tour_destination()
• Joint Tour Scheduling
  • Structure
  • Configuration
    • TourSchedulingSettings
      • TourSchedulingSettings.ALTS_PREPROCESSOR
      • TourSchedulingSettings.COEFFICIENTS
      • TourSchedulingSettings.CONSTANTS
      • TourSchedulingSettings.DESTINATION_FOR_TOUR_PURPOSE
      • TourSchedulingSettings.LOGIT_TYPE
      • TourSchedulingSettings.LOGSUM_PREPROCESSOR
      • TourSchedulingSettings.LOGSUM_SETTINGS
      • TourSchedulingSettings.NESTS
      • TourSchedulingSettings.SIMULATE_CHOOSER_COLUMNS
      • TourSchedulingSettings.SPEC
      • TourSchedulingSettings.SPEC_SEGMENTS
      • TourSchedulingSettings.TOUR_SPEC_SEGMENTS
      • TourSchedulingSettings.compute_settings
      • TourSchedulingSettings.explicit_chunk
      • TourSchedulingSettings.preprocessor
      • TourSchedulingSettings.source_file_paths
      • TourSchedulingSettings.nests_are_for_nl()
      • TourSchedulingSettings.update_sharrow_skip
    • Examples
  • Implementation
    • joint_tour_scheduling()
• Non-Mandatory Tour Frequency
  • Structure
  • Configuration
    • NonMandatoryTourFrequencySettings
      • NonMandatoryTourFrequencySettings.COEFFICIENTS
      • NonMandatoryTourFrequencySettings.CONSTANTS
      • NonMandatoryTourFrequencySettings.LOGIT_TYPE
      • NonMandatoryTourFrequencySettings.NESTS
      • NonMandatoryTourFrequencySettings.SEGMENT_COL
      • NonMandatoryTourFrequencySettings.SPEC
      • NonMandatoryTourFrequencySettings.SPEC_SEGMENTS
      • NonMandatoryTourFrequencySettings.annotate_persons
      • NonMandatoryTourFrequencySettings.annotate_tours
      • NonMandatoryTourFrequencySettings.compute_settings
      • NonMandatoryTourFrequencySettings.explicit_chunk
      • NonMandatoryTourFrequencySettings.preprocessor
      • NonMandatoryTourFrequencySettings.source_file_paths
      • NonMandatoryTourFrequencySettings.nests_are_for_nl()
      • NonMandatoryTourFrequencySettings.update_sharrow_skip
    • Examples
  • Implementation
    • non_mandatory_tour_frequency()
• Non-Mandatory Destination Choice
  • Structure
  • Configuration
    • TourLocationComponentSettings
      • TourLocationComponentSettings.ALT_DEST_COL_NAME
      • TourLocationComponentSettings.CHOOSER_FILTER_COLUMN_NAME
      • TourLocationComponentSettings.CHOOSER_ID_COLUMN
      • TourLocationComponentSettings.CHOOSER_ORIG_COL_NAME
      • TourLocationComponentSettings.CHOOSER_SEGMENT_COLUMN_NAME
      • TourLocationComponentSettings.CHOOSER_TABLE_NAME
      • TourLocationComponentSettings.COEFFICIENTS
      • TourLocationComponentSettings.CONSTANTS
      • TourLocationComponentSettings.DEST_CHOICE_COLUMN_NAME
      • TourLocationComponentSettings.DEST_CHOICE_LOGSUM_COLUMN_NAME
      • TourLocationComponentSettings.DEST_CHOICE_SAMPLE_TABLE_NAME
      • TourLocationComponentSettings.ESTIMATION_SAMPLE_SIZE
      • TourLocationComponentSettings.IN_PERIOD
      • TourLocationComponentSettings.LOGSUM_PREPROCESSOR
      • TourLocationComponentSettings.LOGSUM_SETTINGS
      • TourLocationComponentSettings.LOGSUM_TOUR_PURPOSE
      • TourLocationComponentSettings.MODELED_SIZE_TABLE
      • TourLocationComponentSettings.MODEL_SELECTOR
      • TourLocationComponentSettings.MODE_CHOICE_LOGSUM_COLUMN_NAME
      • TourLocationComponentSettings.ORIG_ZONE_ID
      • TourLocationComponentSettings.OUT_PERIOD
      • TourLocationComponentSettings.SAMPLE_SIZE
      • TourLocationComponentSettings.SAMPLE_SPEC
      • TourLocationComponentSettings.SAVED_SHADOW_PRICE_TABLE_NAME
      • TourLocationComponentSettings.SEGMENTS
      • TourLocationComponentSettings.SEGMENT_IDS
      • TourLocationComponentSettings.SHADOW_PRICE_TABLE
      • TourLocationComponentSettings.SIMULATE_CHOOSER_COLUMNS
      • TourLocationComponentSettings.SIZE_TERM_SELECTOR
      • TourLocationComponentSettings.SPEC
      • TourLocationComponentSettings.annotate_households
      • TourLocationComponentSettings.annotate_persons
      • TourLocationComponentSettings.annotate_tours
      • TourLocationComponentSettings.compute_settings
      • TourLocationComponentSettings.explicit_chunk
      • TourLocationComponentSettings.source_file_paths
      • TourLocationComponentSettings.update_sharrow_skip
    • Examples
  • Implementation
    • non_mandatory_tour_destination()
• Non-Mandatory Tour Scheduling
  • Structure
    • Examples
  • Implementation
    • non_mandatory_tour_scheduling()
• Mandatory Tour Scheduling
  • Structure
    • Examples
  • Implementation
    • mandatory_tour_scheduling()
• Disaggregate Accessibility
  • Structure
  • Configuration
    • DisaggregateAccessibilitySettings
      • DisaggregateAccessibilitySettings.BASE_RANDOM_SEED
      • DisaggregateAccessibilitySettings.CREATE_TABLES
      • DisaggregateAccessibilitySettings.DESTINATION_SAMPLE_SIZE
      • DisaggregateAccessibilitySettings.FROM_TEMPLATES
      • DisaggregateAccessibilitySettings.KEEP_COLS
      • DisaggregateAccessibilitySettings.MERGE_ON
      • DisaggregateAccessibilitySettings.NEAREST_METHOD
      • DisaggregateAccessibilitySettings.ORIGIN_SAMPLE_METHOD
      • DisaggregateAccessibilitySettings.ORIGIN_SAMPLE_SIZE
      • DisaggregateAccessibilitySettings.ORIGIN_WEIGHTING_COLUMN
      • DisaggregateAccessibilitySettings.add_size_tables
      • DisaggregateAccessibilitySettings.annotate_proto_tables
      • DisaggregateAccessibilitySettings.explicit_chunk
      • DisaggregateAccessibilitySettings.postprocess_proto_tables
      • DisaggregateAccessibilitySettings.suffixes
      • DisaggregateAccessibilitySettings.zone_id_names
    • Examples
  • Implementation
• Free Parking Eligibility
  • Structure
  • Configuration
    • FreeParkingSettings
      • FreeParkingSettings.COEFFICIENTS
      • FreeParkingSettings.CONSTANTS
      • FreeParkingSettings.FREE_PARKING_ALT
      • FreeParkingSettings.LOGIT_TYPE
      • FreeParkingSettings.NESTS
      • FreeParkingSettings.SPEC
      • FreeParkingSettings.compute_settings
      • FreeParkingSettings.preprocessor
      • FreeParkingSettings.source_file_paths
      • FreeParkingSettings.nests_are_for_nl()
      • FreeParkingSettings.update_sharrow_skip
    • Examples
  • Implementation
    • free_parking()
• School Location
  • Structure
  • Configuration
    • Examples
  • Implementation
• Transit Pass Ownership
  • Structure
  • Configuration
    • TransitPassOwnershipSettings
      • TransitPassOwnershipSettings.COEFFICIENTS
      • TransitPassOwnershipSettings.CONSTANTS
      • TransitPassOwnershipSettings.LOGIT_TYPE
      • TransitPassOwnershipSettings.NESTS
      • TransitPassOwnershipSettings.SPEC
      • TransitPassOwnershipSettings.compute_settings
      • TransitPassOwnershipSettings.preprocessor
      • TransitPassOwnershipSettings.source_file_paths
      • TransitPassOwnershipSettings.nests_are_for_nl()
      • TransitPassOwnershipSettings.update_sharrow_skip
    • Examples
  • Implementation
    • transit_pass_ownership()
• Transit Pass Subsidy
  • Structure
  • Configuration
    • TransitPassSubsidySettings
      • TransitPassSubsidySettings.CHOOSER_FILTER_COLUMN_NAME
      • TransitPassSubsidySettings.COEFFICIENTS
      • TransitPassSubsidySettings.CONSTANTS
      • TransitPassSubsidySettings.LOGIT_TYPE
      • TransitPassSubsidySettings.NESTS
      • TransitPassSubsidySettings.SPEC
      • TransitPassSubsidySettings.compute_settings
      • TransitPassSubsidySettings.preprocessor
      • TransitPassSubsidySettings.source_file_paths
      • TransitPassSubsidySettings.nests_are_for_nl()
      • TransitPassSubsidySettings.update_sharrow_skip
    • Examples
  • Implementation
    • transit_pass_subsidy()
• Trip Destination
  • Structure
  • Configuration
    • TripDestinationSettings
      • TripDestinationSettings.ALT_DEST_COL_NAME
      • TripDestinationSettings.CLEANUP
      • TripDestinationSettings.DEST_CHOICE_LOGSUM_COLUMN_NAME
      • TripDestinationSettings.DEST_CHOICE_SAMPLE_TABLE_NAME
      • TripDestinationSettings.PRIMARY_DEST
      • TripDestinationSettings.PRIMARY_ORIGIN
      • TripDestinationSettings.REDUNDANT_TOURS_MERGED_CHOOSER_COLUMNS
      • TripDestinationSettings.TRIP_ORIGIN
      • TripDestinationSettings.alts_preprocessor_sample
      • TripDestinationSettings.alts_preprocessor_simulate
      • TripDestinationSettings.fail_some_trips_for_testing
      • TripDestinationSettings.preprocessor
      • TripDestinationSettings.deprecated_destination_prefix()
      • TripDestinationSettings.DESTINATION_SAMPLE_SPEC
      • TripDestinationSettings.DESTINATION_SPEC
    • Examples
  • Implementation
    • trip_destination()
  • Context Variables
  • Additional Related Functions
    • trip_destination_sample()
    • compute_logsums()
    • compute_ood_logsums()
    • trip_destination_simulate()
• Work from Home
  • Structure
  • Configuration
    • WorkFromHomeSettings
      • WorkFromHomeSettings.CHOOSER_FILTER_COLUMN_NAME
      • WorkFromHomeSettings.COEFFICIENTS
      • WorkFromHomeSettings.CONSTANTS
      • WorkFromHomeSettings.DEST_CHOICE_COLUMN_NAME
      • WorkFromHomeSettings.LOGIT_TYPE
      • WorkFromHomeSettings.NESTS
      • WorkFromHomeSettings.SPEC
      • WorkFromHomeSettings.WORK_FROM_HOME_ALT
      • WorkFromHomeSettings.WORK_FROM_HOME_CHOOSER_FILTER
      • WorkFromHomeSettings.WORK_FROM_HOME_COEFFICIENT_CONSTANT
      • WorkFromHomeSettings.WORK_FROM_HOME_ITERATIONS
      • WorkFromHomeSettings.WORK_FROM_HOME_TARGET_PERCENT
      • WorkFromHomeSettings.WORK_FROM_HOME_TARGET_PERCENT_TOLERANCE
      • WorkFromHomeSettings.compute_settings
      • WorkFromHomeSettings.preprocessor
      • WorkFromHomeSettings.source_file_paths
      • WorkFromHomeSettings.nests_are_for_nl()
      • WorkFromHomeSettings.update_sharrow_skip
    • Examples
  • Implementation
    • work_from_home()
• Work Location
  • Structure
  • Configuration
    • Examples
  • Implementation
• Tour Mode Choice
  • Structure
  • Configuration
    • TourModeComponentSettings
      • TourModeComponentSettings.COEFFICIENTS
      • TourModeComponentSettings.COEFFICIENT_TEMPLATE
      • TourModeComponentSettings.COMPUTE_TRIP_MODE_CHOICE_LOGSUMS
      • TourModeComponentSettings.CONSTANTS
      • TourModeComponentSettings.FORCE_ESCORTEE_CHAUFFEUR_MODE_MATCH
      • TourModeComponentSettings.LOGIT_TYPE
      • TourModeComponentSettings.LOGSUM_CHOOSER_COLUMNS
      • TourModeComponentSettings.MODE_CHOICE_LOGSUM_COLUMN_NAME
      • TourModeComponentSettings.NESTS
      • TourModeComponentSettings.SPEC
      • TourModeComponentSettings.annotate_tours
      • TourModeComponentSettings.compute_settings
      • TourModeComponentSettings.nontour_preprocessor
      • TourModeComponentSettings.preprocessor
      • TourModeComponentSettings.source_file_paths
      • TourModeComponentSettings.tvpb_mode_path_types
      • TourModeComponentSettings.use_TVPB_constants
      • TourModeComponentSettings.nests_are_for_nl()
      • TourModeComponentSettings.update_sharrow_skip
    • Examples
  • Implementation
    • tour_mode_choice_simulate()
    • create_logsum_trips()
    • append_tour_leg_trip_mode_choice_logsums()
    • get_trip_mc_logsums_for_all_modes()
    • get_trip_mc_logsums_for_all_modes()
• At-work Subtours Frequency
  • Structure
  • Configuration
    • AtworkSubtourFrequencySettings
      • AtworkSubtourFrequencySettings.COEFFICIENTS
      • AtworkSubtourFrequencySettings.CONSTANTS
      • AtworkSubtourFrequencySettings.LOGIT_TYPE
      • AtworkSubtourFrequencySettings.NESTS
      • AtworkSubtourFrequencySettings.SPEC
      • AtworkSubtourFrequencySettings.compute_settings
      • AtworkSubtourFrequencySettings.preprocessor
      • AtworkSubtourFrequencySettings.source_file_paths
      • AtworkSubtourFrequencySettings.nests_are_for_nl()
      • AtworkSubtourFrequencySettings.update_sharrow_skip
    • Examples
  • Implementation
    • atwork_subtour_frequency()
• At-work Subtours Destination Choice
  • Structure
  • Configuration
    • TourLocationComponentSettings
      • TourLocationComponentSettings.ALT_DEST_COL_NAME
      • TourLocationComponentSettings.CHOOSER_FILTER_COLUMN_NAME
      • TourLocationComponentSettings.CHOOSER_ID_COLUMN
      • TourLocationComponentSettings.CHOOSER_ORIG_COL_NAME
      • TourLocationComponentSettings.CHOOSER_SEGMENT_COLUMN_NAME
      • TourLocationComponentSettings.CHOOSER_TABLE_NAME
      • TourLocationComponentSettings.COEFFICIENTS
      • TourLocationComponentSettings.CONSTANTS
      • TourLocationComponentSettings.DEST_CHOICE_COLUMN_NAME
      • TourLocationComponentSettings.DEST_CHOICE_LOGSUM_COLUMN_NAME
      • TourLocationComponentSettings.DEST_CHOICE_SAMPLE_TABLE_NAME
      • TourLocationComponentSettings.ESTIMATION_SAMPLE_SIZE
      • TourLocationComponentSettings.IN_PERIOD
      • TourLocationComponentSettings.LOGSUM_PREPROCESSOR
      • TourLocationComponentSettings.LOGSUM_SETTINGS
      • TourLocationComponentSettings.LOGSUM_TOUR_PURPOSE
      • TourLocationComponentSettings.MODELED_SIZE_TABLE
      • TourLocationComponentSettings.MODEL_SELECTOR
      • TourLocationComponentSettings.MODE_CHOICE_LOGSUM_COLUMN_NAME
      • TourLocationComponentSettings.ORIG_ZONE_ID
      • TourLocationComponentSettings.OUT_PERIOD
      • TourLocationComponentSettings.SAMPLE_SIZE
      • TourLocationComponentSettings.SAMPLE_SPEC
      • TourLocationComponentSettings.SAVED_SHADOW_PRICE_TABLE_NAME
      • TourLocationComponentSettings.SEGMENTS
      • TourLocationComponentSettings.SEGMENT_IDS
      • TourLocationComponentSettings.SHADOW_PRICE_TABLE
      • TourLocationComponentSettings.SIMULATE_CHOOSER_COLUMNS
      • TourLocationComponentSettings.SIZE_TERM_SELECTOR
      • TourLocationComponentSettings.SPEC
      • TourLocationComponentSettings.annotate_households
      • TourLocationComponentSettings.annotate_persons
      • TourLocationComponentSettings.annotate_tours
      • TourLocationComponentSettings.compute_settings
      • TourLocationComponentSettings.explicit_chunk
      • TourLocationComponentSettings.update_sharrow_skip
    • Examples
  • Implementation
    • atwork_subtour_destination()
• At-work Subtour Scheduling
  • Structure
  • Configuration
    • TourSchedulingSettings
      • TourSchedulingSettings.ALTS_PREPROCESSOR
      • TourSchedulingSettings.COEFFICIENTS
      • TourSchedulingSettings.CONSTANTS
      • TourSchedulingSettings.DESTINATION_FOR_TOUR_PURPOSE
      • TourSchedulingSettings.LOGIT_TYPE
      • TourSchedulingSettings.LOGSUM_PREPROCESSOR
      • TourSchedulingSettings.LOGSUM_SETTINGS
      • TourSchedulingSettings.NESTS
      • TourSchedulingSettings.SIMULATE_CHOOSER_COLUMNS
      • TourSchedulingSettings.SPEC
      • TourSchedulingSettings.SPEC_SEGMENTS
      • TourSchedulingSettings.TOUR_SPEC_SEGMENTS
      • TourSchedulingSettings.compute_settings
      • TourSchedulingSettings.explicit_chunk
      • TourSchedulingSettings.preprocessor
      • TourSchedulingSettings.source_file_paths
      • TourSchedulingSettings.nests_are_for_nl()
      • TourSchedulingSettings.update_sharrow_skip
    • Examples
  • Implementation
    • atwork_subtour_scheduling()
• At-work Subtour Mode
  • Structure
  • Configuration
    • TourModeComponentSettings
      • TourModeComponentSettings.COEFFICIENTS
      • TourModeComponentSettings.COEFFICIENT_TEMPLATE
      • TourModeComponentSettings.COMPUTE_TRIP_MODE_CHOICE_LOGSUMS
      • TourModeComponentSettings.CONSTANTS
      • TourModeComponentSettings.FORCE_ESCORTEE_CHAUFFEUR_MODE_MATCH
      • TourModeComponentSettings.LOGIT_TYPE
      • TourModeComponentSettings.LOGSUM_CHOOSER_COLUMNS
      • TourModeComponentSettings.MODE_CHOICE_LOGSUM_COLUMN_NAME
      • TourModeComponentSettings.NESTS
      • TourModeComponentSettings.SPEC
      • TourModeComponentSettings.annotate_tours
      • TourModeComponentSettings.compute_settings
      • TourModeComponentSettings.nontour_preprocessor
      • TourModeComponentSettings.preprocessor
      • TourModeComponentSettings.source_file_paths
      • TourModeComponentSettings.tvpb_mode_path_types
      • TourModeComponentSettings.use_TVPB_constants
      • TourModeComponentSettings.nests_are_for_nl()
      • TourModeComponentSettings.update_sharrow_skip
    • Examples
  • Implementation
    • atwork_subtour_mode_choice()
• Stop Frequency
  • Structure
  • Configuration
    • StopFrequencySettings
      • StopFrequencySettings.COEFFICIENTS
      • StopFrequencySettings.CONSTANTS
      • StopFrequencySettings.LOGIT_TYPE
      • StopFrequencySettings.NESTS
      • StopFrequencySettings.SEGMENT_COL
      • StopFrequencySettings.SPEC
      • StopFrequencySettings.SPEC_SEGMENTS
      • StopFrequencySettings.compute_settings
      • StopFrequencySettings.preprocessor
      • StopFrequencySettings.source_file_paths
      • StopFrequencySettings.nests_are_for_nl()
      • StopFrequencySettings.update_sharrow_skip
    • Examples
  • Implementation
    • stop_frequency()
• Trip Purpose
  • Structure
  • Configuration
    • Note
    • Examples
  • Implementation
    • trip_purpose()
    • choose_intermediate_trip_purpose()
    • run_trip_purpose()
• Trip Destination
  • Structure
  • Configuration
    • TripDestinationSettings
      • TripDestinationSettings.ALT_DEST_COL_NAME
      • TripDestinationSettings.CLEANUP
      • TripDestinationSettings.DEST_CHOICE_LOGSUM_COLUMN_NAME
      • TripDestinationSettings.DEST_CHOICE_SAMPLE_TABLE_NAME
      • TripDestinationSettings.PRIMARY_DEST
      • TripDestinationSettings.PRIMARY_ORIGIN
      • TripDestinationSettings.REDUNDANT_TOURS_MERGED_CHOOSER_COLUMNS
      • TripDestinationSettings.TRIP_ORIGIN
      • TripDestinationSettings.alts_preprocessor_sample
      • TripDestinationSettings.alts_preprocessor_simulate
      • TripDestinationSettings.fail_some_trips_for_testing
      • TripDestinationSettings.preprocessor
      • TripDestinationSettings.deprecated_destination_prefix()
      • TripDestinationSettings.DESTINATION_SAMPLE_SPEC
      • TripDestinationSettings.DESTINATION_SPEC
    • Examples
  • Implementation
    • trip_destination()
  • Context Variables
  • Additional Related Functions
    • trip_destination_sample()
    • compute_logsums()
    • compute_ood_logsums()
    • trip_destination_simulate()
• Trip Purpose and Destination
  • Structure
  • Configuration
    • TripPurposeAndDestinationSettings
      • TripPurposeAndDestinationSettings.MAX_ITERATIONS
    • Examples
  • Implementation
    • trip_purpose_and_destination()
• Trip Scheduling Choice
  • Structure
  • Configuration
    • TripSchedulingChoiceSettings
      • TripSchedulingChoiceSettings.PREPROCESSOR
      • TripSchedulingChoiceSettings.SPECIFICATION
      • TripSchedulingChoiceSettings.compute_settings
    • Examples
  • Implementation
    • trip_scheduling_choice()
    • generate_schedule_alternatives()
    • no_stops_patterns()
    • stop_one_way_only_patterns()
    • stop_two_way_only_patterns()
    • get_pattern_index_and_arrays()
    • get_spec_for_segment()
• Trip Departure Choice
  • Structure
  • Configuration
    • TripDepartureChoiceSettings
      • TripDepartureChoiceSettings.CONSTANTS
      • TripDepartureChoiceSettings.PREPROCESSOR
      • TripDepartureChoiceSettings.SPECIFICATION
      • TripDepartureChoiceSettings.compute_settings
    • Examples
  • Implementation
    • trip_departure_choice()
• Trip Mode Choice
  • Structure
  • Configuration
    • TripModeChoiceSettings
      • TripModeChoiceSettings.CHOOSER_COLS_TO_KEEP
      • TripModeChoiceSettings.COEFFICIENTS
      • TripModeChoiceSettings.COEFFICIENT_TEMPLATE
      • TripModeChoiceSettings.CONSTANTS
      • TripModeChoiceSettings.FORCE_ESCORTEE_CHAUFFEUR_MODE_MATCH
      • TripModeChoiceSettings.LEGACY_COEFFICIENTS
      • TripModeChoiceSettings.LOGIT_TYPE
      • TripModeChoiceSettings.MODE_CHOICE_LOGSUM_COLUMN_NAME
      • TripModeChoiceSettings.NESTS
      • TripModeChoiceSettings.REDUNDANT_TOURS_MERGED_CHOOSER_COLUMNS
      • TripModeChoiceSettings.SPEC
      • TripModeChoiceSettings.TOURS_MERGED_CHOOSER_COLUMNS
      • TripModeChoiceSettings.TVPB_recipe
      • TripModeChoiceSettings.annotate_trips
      • TripModeChoiceSettings.compute_settings
      • TripModeChoiceSettings.preprocessor
      • TripModeChoiceSettings.source_file_paths
      • TripModeChoiceSettings.tvpb_mode_path_types
      • TripModeChoiceSettings.use_TVPB_constants
      • TripModeChoiceSettings.nests_are_for_nl()
      • TripModeChoiceSettings.update_sharrow_skip
    • Examples
  • Implementation
    • trip_mode_choice()
• Parking Location Choice
  • Structure
    • Required YAML attributes:
  • Configuration
    • ParkingLocationSettings
      • ParkingLocationSettings.ALTERNATIVE_FILTER_COLUMN_NAME
      • ParkingLocationSettings.ALT_DEST_COL_NAME
      • ParkingLocationSettings.AUTO_MODES
      • ParkingLocationSettings.CHOOSER_FILTER_COLUMN_NAME
      • ParkingLocationSettings.CHOOSER_SEGMENT_COLUMN_NAME
      • ParkingLocationSettings.COEFFICIENTS
      • ParkingLocationSettings.CONSTANTS
      • ParkingLocationSettings.DEST_CHOICE_SAMPLE_TABLE_NAME
      • ParkingLocationSettings.LOGIT_TYPE
      • ParkingLocationSettings.NESTS
      • ParkingLocationSettings.PARKING_LOCATION_SAMPLE_TABLE_NAME
      • ParkingLocationSettings.PREPROCESSOR
      • ParkingLocationSettings.SEGMENTS
      • ParkingLocationSettings.SPEC
      • ParkingLocationSettings.SPECIFICATION
      • ParkingLocationSettings.TRIP_DEPARTURE_PERIOD
      • ParkingLocationSettings.TRIP_DESTINATION
      • ParkingLocationSettings.TRIP_ORIGIN
      • ParkingLocationSettings.compute_settings
      • ParkingLocationSettings.explicit_chunk
      • ParkingLocationSettings.source_file_paths
      • ParkingLocationSettings.nests_are_for_nl()
      • ParkingLocationSettings.update_sharrow_skip
    • Examples
  • Implementation
    • parking_location()
    • wrap_skims()
    • parking_destination_simulate()
• Write Trip Matrices
  • Structure
  • Configuration
    • WriteTripMatricesSettings
      • WriteTripMatricesSettings.CONSTANTS
      • WriteTripMatricesSettings.HH_EXPANSION_WEIGHT_COL
      • WriteTripMatricesSettings.MATRICES
      • WriteTripMatricesSettings.SAVE_TRIPS_TABLE
      • WriteTripMatricesSettings.preprocessor
    • Examples
  • Implementation
    • write_trip_matrices()

Note

The documentation for individual components is being migrated to this section. See Models for other components.