Skip to content

Getting Started

Welcome to Risk Bridge! This section provides everything you need to set up the environment, run your first simulation, and test the pipeline on example datasets.

Guides in this Section

  • Installation: Detailed instructions for installing Risk Bridge via uv or pip, installing from source, and setting up dependencies.
  • Quickstart Tutorial: A step-by-step 5-minute walkthrough of running your first simulated scenario and using the Python API.
  • Example Datasets & Walkthrough: Hands-on guide to using the bundled synthetic transport datasets in examples/ for user-data pipeline execution.

Fast Summary

# 1. Install using uv or pip
uv add risk-bridge

# 2. Run a small test simulation
uv run risk-bridge --mode simulated --scenario 1 --nsim 2 --output-root data --run-label test_run

# 3. Check the output directory
ls -la data/*test_run/final