search

LBNL-UCB-STI / beam

The Framework for Modeling Behavior, Energy, Autonomy, and Mobility in Transportation Systems
https://transportation.lbl.gov/beam
Other
147 stars 57 forks source link

Documentation: add information about different physSim and routers we have. #3300

Open nikolayilyin opened 3 years ago

nikolayilyin commented 3 years ago

Currently only JDEQSim and R5 are mentioned in the latest documentation, but we also have BPRSim, ParBPRSim, CCHRoutingAssigment and additional routers - CCH, GH.

One needs to add some information into documentation about mentioned routers and physSim implementations

nikolayilyin commented 2 years ago

Also in the beam-template according config keys should have comments with all possible values

HoneyTauOverTwo commented 2 years ago

beam-template already has comments about these:

physSim beam-template.conf#L478: values: JDEQSim, BPRSim, PARBPRSim, CCHRoutingAssignment

Routing beam-template.conf#L895: values: R5, staticGH, quasiDynamicGH, nativeCCH (Linux Only)

Documentation for phySim and router indeed needs updating

HoneyTauOverTwo commented 2 years ago

I identified the relevant java and scala files related to physics simulation (working on routers), but I might need some help to actually write the documentation.

For instance, what BPR and CCH stand for.

From what I understand, BPR, it is an alternative for Java Discrete Event Queue Simulator (JDEQ) from MATSim. It was implemented by Dima so might need his help.

I guess I'd have to know the difference, advantages, disadvantages of each approach.

As for CCHRoutingAssignment, it appears to be one that bypasses physics simulation ignoring congestion and such.