BAMBAM

Access modeling toolkit for Rust built on the RouteE Compass energy-aware route planner.

The Behavior and Advanced Mobility Big Access Model (BAMBAM) is a mobility research platform for scalable access modeling. The process begins with a grid defined at some spatial granularity (e.g., census block or 1 km grid) and a variety of travel configurations. For each grid cell and configuration, the platform executes constrained searches, uses the results to index points of interest (POI), and aggregates the findings to the grid level. It provides researchers access through R or Python running on HPC. The platform automates the import and merging of datasets from a variety of sources including data.gov (with automatic merging of Tiger/Lines geometries), OpenStreetMaps, OvertureMaps, and GTFS. It is built upon RouteE Compass, a scalable, energy-aware route planner written in Rust, extended to model multiple travel modes.

This software is in a beta phase of development.

Usage

For this initial open-source release, BAMBAM is provided as a set of command line tools, installed using cargo (via rustup): cargo build --release --manifest-path rust/Cargo.toml. We can list the command arguments (will document app as "RouteE Compass"):

$ ./rust/target/release/bambam --help
The RouteE-Compass energy-aware routing engine

Usage: bambam [OPTIONS] --config-file <*.toml> --query-file <*.json>

Options:
  -c, --config-file <*.toml>   RouteE Compass service configuration TOML file
  -q, --query-file <*.json>    JSON file containing queries. Should be newline-delimited if chunksize is set
      --chunksize <CHUNKSIZE>  Size of batches to load into memory at a time
  -n, --newline-delimited      Format of JSON queries file, if regular JSON or newline-delimited JSON
  -h, --help                   Print help
  -V, --version                Print version

Prerequisites

Use RouteE Compass to download a road network in the vectorized Compass format. Simplest workflow via the RouteE Compass Python package (using OSMNx for downloading OSM networks).

import osmnx as ox
from nrel.routee.compass.io import generate_compass_dataset

g = ox.graph_from_place("Denver, Colorado, USA", network_type="drive")
generate_compass_dataset(g, output_directory="denver_co")

Copy the test configuration into the generated denver_co directory:

$ cp configuration/denver_test.toml denver_co/denver_test.toml

Run

To run bambam, use the bambam command and provide the imported network:

$ RUST_LOG=info ./rust/target/release/bambam --config-file denver_co/denver_test.toml --query-file query/denver_extent.json

Roadmap

• Python API
• R API
• OvertureMaps network import
• methodological improvements for walk/bike/drive realism
• transit-mode travel using GTFS Schedule data networks
• multimodal route planning

License

Copyright 2025 Alliance for Sustainable Energy, LLC

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.