Welcome to BEAM docs

BEAM extends the [Multi-Agent Transportation Simulation Framework (MATSim)](http://www.matsim.org/) to enable powerful and scalable analysis of urban transportation systems.

Contents:

• About BEAM
  • Overview
  • MATSim Integration
    • BeamMobSim
    • AgentSim
    • PhysSim
    • R5 Router
    • MATSim Events
  • Resource Markets
  • Dynamic Within-Day Planning
  • Rich Modal Choice
  • Plug-in Electric Vehicle Modeling with BEAM
  • Contact Information
  • Reports and Papers
  • References
• User’s Guide
  • Getting Started
    • System Requirements
    • Prerequisites :
    • GIT-LFS Configuration
    • Installing BEAM
    • Running BEAM
    • Running BEAM with Intellij IDE
    • Scenarios
    • Inputs
    • Outputs
    • Model Config
  • Experiment Manager
  • Calibration
    • Optimization-based Calibration Principles
    • SigOpt Setup
    • Configuration
    • Execution
    • Manage Experiment
  • Timezones and GTFS
  • Converting a MATSim Scenario to Run with BEAM
    • Conversion Instructions
• Developer’s Guide
  • Repositories
  • Configuration
  • Environment Variables
  • GIT-LFS timeout - how to proceed
  • Keeping Production Data out of Master Branch
  • Automated Cloud Deployment
    • AWS EC2 Start
    • AWS EC2 Stop
  • Performance Monitoring
    • Beam Metrics Utility (MetricsSupport)
    • Beam Metrics Configuration
    • Setup Docker as Metric Backend
  • Tagging Tests for Periodic CI
  • Instructions for forking BEAM
  • Scala tips
    • Scala Collection
    • Use lazy logging
• BeamAgents
  • Person Agents
  • Ride Hail Agents
  • Transit Driver Agents
• Behaviors
  • Mode Choice
    • Multinomial Logit Mode Choice
    • Latent Class Mode Choice
  • Parking
  • Refueling
• Event Specifications
  • MATSim Events
    • ActivityStartEvent
    • ActivityEndEvent
    • PersonDepartureEvent
    • PersonArrivalEvent
    • PersonEntersVehicleEvent
    • PersonLeavesVehicleEvent
  • BEAM Events
    • ModeChoiceEvent
    • PathTraversalEvent
• Model Inputs
  • Configuration file
    • Config Options
• Model Outputs
  • File: /modeChoice.csv
  • File: /referenceModeChoice.csv
  • File: /realizedMode.csv
  • File: /rideHailRevenue.csv
  • File: /ITERS/it.0/0.averageTravelTimes.csv
  • File: /ITERS/it.0/0.energyUse.png.csv
  • File: /ITERS/it.0/0.physsimLinkAverageSpeedPercentage.csv
  • File: /ITERS/it.0/0.physsimFreeFlowSpeedDistribution.csv
  • File: /ITERS/it.0/0.rideHailWaitingStats.csv
  • File: /ITERS/it.0/0.rideHailIndividualWaitingTimes.csv
  • File: /ITERS/it.0/0.rideHailSurgePriceLevel.csv
  • File: /ITERS/it.0/0.rideHailRevenue.csv
  • File: /ITERS/it.0/0.tazRideHailSurgePriceLevel.csv
  • File: /ITERS/it.0/0.rideHailWaitingSingleStats.csv
  • File: /ITERS/it.0/0.rideHailInitialLocation.csv
  • File: /stopwatch.txt
  • File: /scorestats.txt
  • File: /summaryStats.txt
  • File: /ITERS/it.0/0.countsCompare.txt
  • File: /ITERS/it.0/0.events.csv
  • File: /ITERS/it.0/0.legHistogram.txt
  • File: /ITERS/it.0/0.rideHailTripDistance.csv
  • File: /ITERS/it.0/0.tripDuration.txt
  • File: /ITERS/it.0/0.biasErrorGraphData.txt
  • File: /ITERS/it.0/0.biasNormalizedErrorGraphData.txt
• Protocols
  • Trip Planning
    • RoutingRequests
    • ChoosesMode
  • Traveling
    • Driver
    • Traveler
  • Household
    • Escort
  • RideHailing
    • Inquiry
    • Reserve
  • Transit
  • Refueling
  • Modify Passenger Schedule Manager
• DevOps Guide
  • Git LFS
    • Setup git-lfs Server
  • Jenkins
    • Setup Jenkins Server
    • Setup Jenkins Slave
    • Configure Jenkins Master
    • Configure Jenkins Jobs
    • Configure Periodic Jobs
    • References
  • Automated Cloud Deployment
    • Automatic Image (AMI) Update

Indices and tables

• Index
• Module Index
• Search Page