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
    • GraphHopper Router
    • MATSim Events
  • Resource Markets
  • Dynamic Within-Day Planning
  • Rich Modal Choice
  • Plug-in Electric Vehicle Modeling with BEAM
  • Contact Information
  • References
• User’s Guide
  • Getting Started
    • System Requirements
    • Prerequisites :
    • GIT-LFS Configuration
    • Installing BEAM
    • Running BEAM
    • Running BEAM with Intellij IDE
    • BEAM in Docker image
    • Scenarios
    • Inputs
    • Outputs
    • Data Analysis
    • 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
  • Converting BEAM events file into MATSim events file
• Beam Tutorial
  • Urbansim SF-light Scenario
  • Urbansim SF-light Scenario with mode choice in Beam
  • Changing Ride-Hail Fleet Size
  • Simulation Result Analysis
• Developer’s Guide
  • Repositories
  • Configuration
  • Environment Variables
  • GIT-LFS - known issues
  • Running on IntelliJ
  • Developing with Multiple Java Versions
  • Production Data And Git Submodules
    • Using old production data
    • Adding new production scenario
    • Running Jupyter Notebook
    • Organizing jupyter notebooks
    • Beam Metrics Utility (MetricsSupport)
    • Beam Metrics Configuration
    • Setup Docker as Metric Backend
  • Tagging Tests for Periodic CI
  • Instructions for forking BEAM
  • Build BEAM docker image
  • Scala tips
    • Scala Collection
    • Use lazy logging
• Auto Capturing Beam Messages
  • Capturing most messages that BEAM Actors generate
  • Generated csv files
  • How to visualize them
    • Parameters
    • Diagram types
    • Converting puml files to pictures
• Real time graphs
  • Grafana
  • Docker installation and configuration
    • Ubuntu Linux users
    • Mac users
    • Windows users
    • Verify docker installation
  • Control Grafana using gradle commands
    • Start Grafana
    • Stop Grafana
    • Clear collected data
  • Working with Grafana graphs
    • Select dashboard
    • Select BEAM run
    • Disable and enable data traces
    • Select BEAM iteration
    • Select data update frequency
    • Iteration Map View
  • Configure BEAM metrics in Grafana
    • Existing metrics
    • New metrics
  • Troubleshooting
• BeamAgents
  • Person Agents
  • Ride Hail Agents
  • Transit Driver Agents
• Behaviors
  • Mode Choice
    • Multinomial Logit Mode Choice
    • Latent Class Mode Choice
  • Parking
  • Refueling
  • Reposition
• Event Specifications
  • MATSim Events
    • ActivityStartEvent
    • ActivityEndEvent
    • PersonDepartureEvent
    • PersonArrivalEvent
    • PersonEntersVehicleEvent
    • PersonLeavesVehicleEvent
    • LinkEnterEvent
    • LinkLeaveEvent
    • VehicleEntersTrafficEvent
    • VehicleLeavesTrafficEvent
  • BEAM Events
    • ModeChoiceEvent
    • PathTraversalEvent
    • ChargingPlugInEvent
    • ChargingPlugOutEvent
    • FleetStoredElectricityEvent
    • LeavingParkingEvent
    • ParkingEvent
    • RefuelSessionEvent
    • RideHailReservationConfirmationEvent
    • ShiftEvent
    • TeleportationEvent
    • AgencyRevenueEvent
    • PersonCostEvent
    • ReplanningEvent
    • ReserveRideHailEvent
    • FleetStoredElectricityEvent
• Model Inputs
  • Configuration file
    • General parameters
    • Scenario parameters
    • Mode choice parameters
    • Trip Behavior
    • Choosing Parking
    • Vehicles
    • Population
    • TAZs, Scaling, and Physsim Tuning
    • Routing Configuration
    • Charging Network Manager
    • Warm Mode
    • Ride hail management
    • Secondary activities generation
    • Agents and Activities
    • Replanning
    • Calibration
    • Output
    • Simulation metric
    • Defining what data BEAM writes out
    • Termination criterion name options
    • Debug configuration
    • Technical parameters
    • Matsim parameters
    • Parameters that are not supported anymore
• Model Outputs
  • File: /activityType.csv
  • File: /AverageCarSpeed.csv
  • File: /CarSpeed.csv
  • File: /CarTravelDistance.csv
  • File: /CarTravelTime.csv
  • File: /dataDescriptors.csv
  • File: /FreeFlowCarSpeed.csv
  • File: /FreeFlowCarTravelTime.csv
  • File: /households.csv.gz
  • File: /ITERS/it.0/0.activityType.csv
  • File: /ITERS/it.0/0.CarRideStats.personal.csv
  • File: /ITERS/it.0/0.CarRideStats.ridehail.csv
  • File: /ITERS/it.0/0.expectedMaxUtilityHeatMap.csv
  • File: /ITERS/it.0/0.final_vehicles.csv
  • File: /modeChoice.csv
  • File: /referenceModeChoice.csv
  • File: /ITERS/it.0/0.modeChoice.csv
  • File: /modeChoice_commute.csv
  • File: /network.csv.gz
  • File: /plans.csv.gz
  • File: /ITERS/it.0/0.plans.csv.gz
  • File: /population.csv.gz
  • File: /realizedModeChoice.csv
  • File: /ITERS/it.0/0.activitySimODSkims_current.csv.gz
  • File: /realizedModeChoice_commute.csv
  • File: /referenceModeChoice_commute.csv
  • File: /referenceRealizedModeChoice.csv
  • File: /ITERS/it.0/0.realizedMode.csv
  • File: /referenceRealizedModeChoice_commute.csv
  • File: /replanningEventReason.csv
  • File: /replanningEventReason_commute.csv
  • File: /ITERS/it.0/0.realizedMode_commute.csv
  • File: /ITERS/it.0/0.replanningCountModeChoice.csv
  • File: /ITERS/it.0/0.replanningCountModeChoice_commute.csv
  • File: /ITERS/it.0/0.replanningEventChain.csv
  • File: /ITERS/it.0/0.replanningEventChain_commute.csv
  • File: /ITERS/it.0/0.replanningEventReason.csv
  • File: /ITERS/it.0/0.replanningEventReason_commute.csv
  • File: /ridehailParking.csv
  • File: /rideHailRevenue.csv
  • File: /ITERS/it.0/0.ridehailRides.csv.gz
  • File: /rideHailRideUtilization.csv
  • File: /ITERS/it.0/0.rideHailInitialLocation.csv
  • File: /summaryVehicleStats.csv
  • File: /ITERS/it.0/0.modeChosenAvailableAlternativesCount.csv
  • File: /ITERS/it.0/0.modeChosenAvailableAlternativesCount_commute.csv
  • File: /ITERS/it.0/0.NonArrivedAgentsAtTheEndOfSimulation.csv
  • File: /ITERS/it.0/0.passengerPerTrip{Transit Mode}.csv
  • File: /ITERS/it.0/0.parkingStats.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.rideHailWaitingHistogram.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.gz
  • File: /ITERS/it.0/0.rideHailWaitingSingleStats.csv
  • File: /ITERS/it.0/0.rideHailWaitingStats.csv
  • File: /ITERS/it.0/0.routeHistory.csv.gz
  • File: /ITERS/it.0/0.routingModeChoice.csv
  • File: /ITERS/it.0/0.skimsFreight.csv.gz
  • File: /ITERS/it.0/0.skimsFreight_Aggregated.csv.gz
  • File: /ITERS/it.0/0.skimsOD.csv.gz
  • File: /ITERS/it.0/0.skimsOD_Aggregated.csv.gz
  • File: /ITERS/it.0/0.skimsParking.csv.gz
  • File: /ITERS/it.0/0.skimsParking_Aggregated.csv.gz
  • File: /ITERS/it.0/0.skimsRidehail.csv.gz
  • File: /ITERS/it.0/0.skimsRidehail_Aggregated.csv.gz
  • File: /ITERS/it.0/0.skimsTAZ.csv.gz
  • File: /ITERS/it.0/0.skimsTAZ_Aggregated.csv.gz
  • File: /ITERS/it.0/0.skimsTransitCrowding.csv.gz
  • File: /ITERS/it.0/0.skimsTransitCrowding_Aggregated.csv.gz
  • File: /ITERS/it.0/0.skimsTravelTimeObservedVsSimulated.csv.gz
  • File: /ITERS/it.0/0.skimsTravelTimeObservedVsSimulated_Aggregated.csv.gz
  • File: /ITERS/it.0/0.transitOccupancyByStop.csv
  • File: /stopwatch.txt
  • File: /scorestats.txt
  • File: /summaryStats.csv
  • 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.tripdurations.txt
  • File: /ITERS/it.0/0.biasErrorGraphData.txt
  • File: /ITERS/it.0/0.biasNormalizedErrorGraphData.txt
  • File: /ITERS/it.0/0.rideHailFleet{Manager Name}.csv.gz
  • File: /rideHailStats.csv
  • File: /vehicles.csv.gz
• Protocols
  • Trip Planning
    • RoutingRequests
    • ChoosesMode
  • Traveling
    • Driver
    • Traveler
  • Household
    • Escort
  • RideHailing
    • Inquiry
    • Reserve
  • Transit
  • Modify Passenger Schedule Manager

Indices and tables

• Index

• Module Index

• Search Page