translinkforecasting/rtmdoc

rtm documentation for users and developers by TransLink Forecasting

rtmdoc's Issues

Update rtmdoc for RTM3.5

The advanced input section had already been added, but certain sections of the documentation refers to old versions and outdated folder structures. These information need to be updated to avoid confusion.

Also, it would be good to look into version tagging of the documentation as part of readthedocs.

populate user guide

transit perception factor

Current writeup says "Note that the boarding perception factor used for transfer boarding only. The model assumed there is no penalty for initial boarding. Current model only account perception impact for work purpose only." - this is outdated

1. boarding time of 1 minute/boarding is added to transit travel time
2. each boarding is perceived as 10 minutes (not an exception for initial boarding)
3. perception factor is applied to all purposes in transit assignment

Info from Ali Darwiche:
basically in mode choice you feed the model the real boardings (not peceived)
the perception comes from the coefficients of mode choice
for example IVTT coeff ~ -0.05
boarding coeff ~ -0.5

populate / revise about section

We should think about filling in the about section, if time permits.

Add detail to custom inputs

• Describe how it works/what it does

• Describe how to use it (where to put the file, how to format)

• Show sample files

initial set up

setting up repository to publish content to https://translinkforecasting.github.io/rtmdoc and https://rtm.readthedocs.io/