Code Monkey home page Code Monkey logo

rtmdoc's Introduction

RTM Documentation for Users and Developers

Build Status RTD Build Status

This is a mkdocs-generated documentation for the Regional Transportation Model (RTM) by TransLink Forecasting. This repository has been set up with GitHub Workflow and readthedoc for automated deployment.

Please visit the documentation on github.io or readthedoc.

Getting Started

As rtmdoc collaborators, you are invited to contribute to the documentation for RTM. This documentation is compiled using mkdocs.

Follow the steps below create or update mkdocs-generated html:

Install prerequisites

  • download and install git
  • download and install python anaconda
  • set up environment with prerequisites:
    • conda remove --name rtmdoc --all
    • conda create -n rtmdoc python=3.9 pip
    • conda activate rtmdoc
    • pip install -U -r requirements/project.txt

Clone rtmdoc and develop

  • clone git repository: git clone https://github.com/TransLinkForecasting/rtmdoc.git
  • test build locally: mkdocs build
  • test development : mkdocs serve
  • commit and push your temp branch and create a pull request:
    • git checkout -b master_pr_num
    • git commit
    • git push origin master_pr_num

Build task with VSCode

  • Inside VSCode, go to Terminal -> Run Build Task
    • This will automatically call mkdocs serve using the setting inside .vscode/tasks.json

rtmdoc's People

Contributors

bwentl avatar rkellertl avatar translinkforecasting avatar xhan0703 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

rtmdoc's Issues

initial set up

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

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

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

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.