Skip to content

Commit

Permalink
documentation fixes [makedocs]
Browse files Browse the repository at this point in the history
  • Loading branch information
vivekyadav26 committed Oct 30, 2023
1 parent f415d43 commit b10c538
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 19 deletions.
6 changes: 3 additions & 3 deletions docs/dev-guide/components/initialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ value-of-time. This step also pre-loads the land_use, households, persons, and
random seeds are set differently for each step and therefore the sampling of households depends on which step
they are initially loaded in.

The main interface to the initialize land use step is the :py:func:`~activitysim.abm.models.initialize.initialize_landuse`
function. The main interface to the initialize household step is the :py:func:`~activitysim.abm.models.initialize.initialize_households`
function. The main interface to the initialize tours step is the :py:func:`~activitysim.abm.models.initialize_tours.initialize_tours`
The main interface to the initialize land use step is the [initialize_landuse](activitysim.abm.models.initialize.initialize_landuse)
function. The main interface to the initialize household step is the [initialize_households](activitysim.abm.models.initialize.initialize_households)
function. The main interface to the initialize tours step is the [initialize_tours](activitysim.abm.models.initialize_tours.initialize_tours)
function. These functions are registered as Inject steps in the example Pipeline.


Expand Down
6 changes: 3 additions & 3 deletions docs/dev-guide/components/initialize_los.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ The initialize LOS model isn't really a model, but rather a series of data proce
The initialize LOS model does two things:

* Loads skims and cache for later if desired
* Loads network LOS inputs for transit virtual path building (see :ref:`transit_virtual_path_builder`), pre-computes tap-to-tap total utilities and cache for later if desired
* Loads network LOS inputs for transit virtual path building (see [transit_virtual_path_builder](transit_virtual_path_builder), pre-computes tap-to-tap total utilities and cache for later if desired


The main interface to the initialize LOS step is the :py:func:`~activitysim.abm.models.initialize_los.initialize_los`
function. The main interface to the initialize TVPB step is the :py:func:`~activitysim.abm.models.initialize_los.initialize_tvpb`
The main interface to the initialize LOS step is the [initialize_los](activitysim.abm.models.initialize_los.initialize_los)
function. The main interface to the initialize TVPB step is the [initialize_tvpb](activitysim.abm.models.initialize_los.initialize_tvpb)

function. These functions are registered as Inject steps in the example Pipeline.

Expand Down
9 changes: 2 additions & 7 deletions docs/dev-guide/components/transit_pass_ownership.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
(component-transit-pass-ownership)=
# Transit Pass Ownership


```{eval-rst}
.. currentmodule:: activitysim.abm.models.transit_pass_ownership
```

The transit fare discount is defined as persons who purchase or are
provided a transit pass. The transit fare discount consists of two submodels - this
transit pass ownership model and a person :ref:`transit_pass_subsidy` model. The
transit pass ownership model and a person [transit_pass_subsidy](transit_pass_subsidy) model. The
result of this model can be used to condition downstream models such as the tour and trip
mode choice models via fare discount adjustments.

The main interface to the transit pass ownership model is the
:py:func:`~activitysim.abm.models.transit_pass_ownership` function. This
[transit_pass_ownership](activitysim.abm.models.transit_pass_ownership) function. This
function is registered as an Inject step in the example Pipeline.

This model generates only True or False outcomes, and is structured as a binary
Expand All @@ -24,10 +23,6 @@ logit model.
- *Configuration File*: `transit_pass_ownership.yaml`
- *Core Table*: `persons`
- *Result Field*: `transit_pass_ownership`
- *Skim Keys*: NA




## Configuration

Expand Down
9 changes: 3 additions & 6 deletions docs/dev-guide/components/transit_pass_subsidy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

The transit pass subsidy model is a component of the transit fare discount model, which models persons who purchase or are
provided a transit pass. The transit fare discount consists of two submodels - this
transit pass subsidy model and a person :ref:`transit_pass_ownership` model. The
transit pass subsidy model and a person [transit_pass_ownership](transit_pass_ownership) model. The
result of this model can be used to condition downstream models such as the
person :ref:`transit_pass_ownership` model and the tour and trip mode choice models
person [transit_pass_ownership](transit_pass_ownership) model and the tour and trip mode choice models
via fare discount adjustments.

The main interface to the transit pass subsidy model is the
:py:func:`~activitysim.abm.models.transit_pass_subsidy` function. This
[transit_pass_subsidy](activitysim.abm.models.transit_pass_subsidy) function. This
function is registered as an Inject step in the example Pipeline.

## Structure
Expand All @@ -22,9 +22,6 @@ function is registered as an Inject step in the example Pipeline.
- *Core Table*: `persons`
- *Result Field*: `transit_pass_subsidy`




## Configuration

```{eval-rst}
Expand Down

0 comments on commit b10c538

Please sign in to comment.