From 529a4df3f18c2f44d856b4339c7c391e503b7f67 Mon Sep 17 00:00:00 2001 From: Vivek Yadav Date: Thu, 9 Nov 2023 15:16:42 -0600 Subject: [PATCH] documentation updates [makedocs] --- docs/dev-guide/components/cdap.md | 2 +- docs/dev-guide/components/initialize_los.md | 2 ++ docs/dev-guide/components/joint_tour_participation.md | 1 + docs/dev-guide/components/non_mandatory_tour_frequency.md | 1 + docs/dev-guide/components/parking_location_choice.md | 2 ++ docs/dev-guide/components/tour_mode_choice.md | 6 +++++- docs/dev-guide/components/trip_purpose.md | 4 +++- docs/dev-guide/components/trip_purpose_and_destination.md | 1 - docs/dev-guide/components/trip_scheduling_choice.md | 6 ++++++ docs/dev-guide/components/vehicle_allocation.md | 2 ++ docs/dev-guide/components/vehicle_type_choice.md | 8 ++++++++ 11 files changed, 31 insertions(+), 4 deletions(-) diff --git a/docs/dev-guide/components/cdap.md b/docs/dev-guide/components/cdap.md index 9bf2c8d91..84d243df0 100644 --- a/docs/dev-guide/components/cdap.md +++ b/docs/dev-guide/components/cdap.md @@ -49,5 +49,5 @@ at [cdap](activitysim.abm.models.util.cdap) and contains CDAP model logic. ## Implementation ```{eval-rst} -.. autofunction:: cdap +.. autofunction:: cdap_simulate ``` diff --git a/docs/dev-guide/components/initialize_los.md b/docs/dev-guide/components/initialize_los.md index 8b83ce46f..98f0363c6 100644 --- a/docs/dev-guide/components/initialize_los.md +++ b/docs/dev-guide/components/initialize_los.md @@ -20,4 +20,6 @@ function. These functions are registered as Inject steps in the example Pipelin ```{eval-rst} .. autofunction:: initialize_los +.. autofunction:: compute_utilities_for_attribute_tuple +.. autofunction:: initialize_tvpb ``` diff --git a/docs/dev-guide/components/joint_tour_participation.md b/docs/dev-guide/components/joint_tour_participation.md index c940473de..192e4bfab 100644 --- a/docs/dev-guide/components/joint_tour_participation.md +++ b/docs/dev-guide/components/joint_tour_participation.md @@ -43,4 +43,5 @@ function. This function is registered as an Inject step in the example Pipeline ```{eval-rst} .. autofunction:: joint_tour_participation +.. autofunction:: participants_chooser ``` diff --git a/docs/dev-guide/components/non_mandatory_tour_frequency.md b/docs/dev-guide/components/non_mandatory_tour_frequency.md index 586f33075..97b2e728c 100644 --- a/docs/dev-guide/components/non_mandatory_tour_frequency.md +++ b/docs/dev-guide/components/non_mandatory_tour_frequency.md @@ -42,4 +42,5 @@ function. This function is registered as an Inject step in the example Pipeline ```{eval-rst} .. autofunction:: non_mandatory_tour_frequency +.. autofunction:: extend_tour_counts ``` diff --git a/docs/dev-guide/components/parking_location_choice.md b/docs/dev-guide/components/parking_location_choice.md index dcda1f996..4228052cf 100644 --- a/docs/dev-guide/components/parking_location_choice.md +++ b/docs/dev-guide/components/parking_location_choice.md @@ -73,4 +73,6 @@ is registered as an Inject step, and it is available from the pipeline. ```{eval-rst} .. autofunction:: parking_location +.. autofunction:: wrap_skims +.. autofunction:: parking_destination_simulate ``` diff --git a/docs/dev-guide/components/tour_mode_choice.md b/docs/dev-guide/components/tour_mode_choice.md index c349826dd..43c95c38c 100644 --- a/docs/dev-guide/components/tour_mode_choice.md +++ b/docs/dev-guide/components/tour_mode_choice.md @@ -60,5 +60,9 @@ See [writing_logsums](writing_logsums) for how to write logsums for estimation. ## Implementation ```{eval-rst} -.. autofunction:: tour_mode_choice +.. autofunction:: tour_mode_choice_simulate +.. autofunction:: create_logsum_trips +.. autofunction:: append_tour_leg_trip_mode_choice_logsums +.. autofunction:: get_trip_mc_logsums_for_all_modes +.. autofunction:: get_trip_mc_logsums_for_all_modes ``` diff --git a/docs/dev-guide/components/trip_purpose.md b/docs/dev-guide/components/trip_purpose.md index 4acfedcf3..671db4091 100644 --- a/docs/dev-guide/components/trip_purpose.md +++ b/docs/dev-guide/components/trip_purpose.md @@ -2,7 +2,7 @@ # Trip Purpose ```{eval-rst} -.. currentmodule:: activitysim.abm.models.trip_purpose.py +.. currentmodule:: activitysim.abm.models.trip_purpose ``` For trip other than the last trip outbound or inbound, assign a purpose based on an @@ -41,4 +41,6 @@ Trip purpose and trip destination choice can be run iteratively together [trip_p ```{eval-rst} .. autofunction:: trip_purpose +.. autofunction:: choose_intermediate_trip_purpose +.. autofunction:: run_trip_purpose ``` diff --git a/docs/dev-guide/components/trip_purpose_and_destination.md b/docs/dev-guide/components/trip_purpose_and_destination.md index 8ec5653cb..8d074fa08 100644 --- a/docs/dev-guide/components/trip_purpose_and_destination.md +++ b/docs/dev-guide/components/trip_purpose_and_destination.md @@ -15,7 +15,6 @@ function. This function is registered as an Inject step in the example Pipeline ## Structure - - *Core Table*: `trips` - *Result Field*: `purpose, destination` - *Skims Keys*: `origin, (tour primary) destination, dest_taz, trip_period` diff --git a/docs/dev-guide/components/trip_scheduling_choice.md b/docs/dev-guide/components/trip_scheduling_choice.md index 37e82890c..186078e8f 100644 --- a/docs/dev-guide/components/trip_scheduling_choice.md +++ b/docs/dev-guide/components/trip_scheduling_choice.md @@ -34,4 +34,10 @@ main components of a tour. ```{eval-rst} .. autofunction:: trip_scheduling_choice +.. autofunction:: generate_schedule_alternatives +.. autofunction:: no_stops_patterns +.. autofunction:: stop_one_way_only_patterns +.. autofunction:: stop_two_way_only_patterns +.. autofunction:: get_pattern_index_and_arrays +.. autofunction:: get_spec_for_segment ``` diff --git a/docs/dev-guide/components/vehicle_allocation.md b/docs/dev-guide/components/vehicle_allocation.md index 4ba8e51b2..68d6de034 100644 --- a/docs/dev-guide/components/vehicle_allocation.md +++ b/docs/dev-guide/components/vehicle_allocation.md @@ -44,4 +44,6 @@ selected vehicle to be used in two separate tours at the same time. ```{eval-rst} .. autofunction:: vehicle_allocation +.. autofunction:: annotate_vehicle_allocation +.. autofunction:: get_skim_dict ``` diff --git a/docs/dev-guide/components/vehicle_type_choice.md b/docs/dev-guide/components/vehicle_type_choice.md index 6ac97e172..605309749 100644 --- a/docs/dev-guide/components/vehicle_type_choice.md +++ b/docs/dev-guide/components/vehicle_type_choice.md @@ -59,4 +59,12 @@ Further discussion of output results and model sensitivities can be found [here] ```{eval-rst} .. autofunction:: vehicle_type_choice +.. autofunction:: append_probabilistic_vehtype_type_choices +.. autofunction:: annotate_vehicle_type_choice_households +.. autofunction:: annotate_vehicle_type_choice_persons +.. autofunction:: annotate_vehicle_type_choice_vehicles +.. autofunction:: get_combinatorial_vehicle_alternatives +.. autofunction:: construct_model_alternatives +.. autofunction:: get_vehicle_type_data +.. autofunction:: iterate_vehicle_type_choice ```