Skip to content

Commit 39b2b2a

Browse files
committed
update doc
1 parent bbe2866 commit 39b2b2a

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/dev-guide/components/telecommute_status.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,34 @@
11
(component-telecommute_status)=
2-
#Telecommute Status
2+
# Telecommute Status
33

44
```{eval-rst}
55
.. currentmodule:: activitysim.abm.models.telecommute_status
66
```
77

8-
The ActivitySim telecommute model consists of two long term submodels -
8+
ActivitySim telecommute representation consists of two long term submodels -
99
a person [work_from_home](work_from_home) model and
1010
a person [telecommute_frequency](telecommute_frequency) model.
1111
The work from home model predicts if a worker works exclusively from home,
12-
whereas the telecommute frequency model predicts number of days in a week a worker telecommuters, if they do not exclusively work from home.
13-
However, neither of them predicts whether a worker is telecommuting or not on the simulation day.
14-
This telecommute status model extends the previous two models to predicts for all workers whether they
15-
are telecommuting on the simulation day.
12+
whereas the telecommute frequency model predicts number of days in a week a worker telecommuters,
13+
if they do not exclusively work from home.
14+
However, neither of them predicts whether a worker telecommutes or not on the simulation day.
15+
This telecommute status model extends the previous two models to predict for all workers whether
16+
they telecommute on the simulation day.
1617

1718
A simple implementation of the telecommute status model can be based on the worker's telecommute frequency.
18-
For example, if a worker telecommutes 4 days a week, then there is a 80% probability for them to telecommute on the simulation day.
19+
For example, if a worker telecommutes 4 days a week, then there is a 80% probability for them
20+
to telecommute on the simulation day.
1921
The telecommute status model software can accommodate more complex model forms if needed.
2022

2123
There have been discussions on exactly where the telecommute status model should be added
22-
in the model sequence. Some suggest it should be applied to all workers before the CDAP model; some suggest
23-
it should be applied after the CDAP model, only to workers who have work activities (regardless of in-home or
24-
out-of-home). The Consortium is currently engaged in an explicit telecommute design task as part pf Phase 9B,
24+
in the model sequence. Some suggest it should be applied to all workers before the CDAP model;
25+
some suggest it should be applied after the CDAP model only to workers who have work activities
26+
during the day regardless of in-home or out-of-home (which requires change in CDAP definition).
27+
The Consortium is currently engaged in an explicit telecommute design task as part pf Phase 9B,
2528
out of which more guidance on the model sequence will be established.
2629

2730
The main interface to the telecommute status model is the
28-
[telecommute_status](activitysim.abm.models.telecommute_status) function. This
31+
[telecommute_status](activitysim.abm.models.telecommute_status) function. This
2932
function is registered as an Inject step in the example Pipeline.
3033

3134
## Structure

0 commit comments

Comments
 (0)