Skip to content

API Reference

The trafficpipeline package exposes the following modules:

Module Description
config City definitions, time periods, constants
utils Timestamp extraction, geometry hashing, filters
aggregate Raw GeoPackage → time-period aggregation
eda Data validation & exploratory analysis
geostatistics Spatial statistics & hot-spot analysis
bottleneck Road-capacity bottleneck analysis (OSMnx)
poi POI-congestion density analysis
synthesis Temporal vs spatial predictor comparison
multilevel Multilevel variance decomposition (mixed-effects models)
markov LISA Markov & Spatial Markov transition analysis
speed_validation Speed-based validation across congestion metrics
h3_robustness H3 hexagonal aggregation for MAUP robustness
positive_control Positive control: free-flow vs current speed R²

Importing

# Import specific functions
from trafficpipeline.aggregate import aggregate_city
from trafficpipeline.config import CITIES, get_city

# Import a module
from trafficpipeline import geostatistics
geostatistics.run_analysis(base_dir=".")

# New v0.4.0 modules
from trafficpipeline.multilevel import fit_multilevel_models
from trafficpipeline.markov import compute_lisa, classic_markov, spatial_markov
from trafficpipeline.speed_validation import anova_all_metrics
from trafficpipeline.h3_robustness import h3_aggregate, resolution_sweep
from trafficpipeline.positive_control import compute_positive_control