config.yaml

# ActivitySim Visualizer Configuration
# Canonical config example using the current schema.

name: "Example ActivitySim Visualizer"
root: artifacts
log_level: INFO

pipeline:
  steps:
    - prepare
    - skimjoin
    - segment
    - summarize
    - dashboard
  dashboard_mode: live # live | export | host
  overwrite: false

# ---------------------------------------------------------------------------
# ActivitySim output file names
# Use stems (no extension) for automatic format detection.
# ---------------------------------------------------------------------------
files:
  households: final_households
  persons: final_persons
  tours: final_tours
  trips: final_trips
  joint_tour_participants: final_joint_tour_participants
  land_use: final_land_use

# Optional shared fallback files for optional inputs that may be missing in
# some run folders. These must be explicit .csv or .parquet paths.
# fallback_files:
#   land_use: C:\path\to\shared\land_use.csv

# ---------------------------------------------------------------------------
# Runs to compare
# `runs[*].skimjoin` overrides the global `skimjoin.defaults` settings.
# `prepared_table_map` entries must be explicit .csv or .parquet paths.
#
# Use `file_map` when using non-standard input filenames
#
# use `prepared_table_map` if you have prepared tables you want to use other
# than the cached prepared tables. For example, you could run the `prepare`
# step of the pipeline, perform your own filtering operations on the 
# prepared tables, then read your filtered prepared tables into the
# `summarize` and `dashboard` steps.
# ---------------------------------------------------------------------------
runs:
  - dir: path\to\activitysim\output\run1
    label: Base
    # skimjoin:
    #   config_path: configs/example_skimjoin.yaml
    #   skim_files:
    #     - C:\path\to\model_skims\*.omx
    #     - C:\path\to\model_skims\maz_stop_walk.csv
    #   network_los_file: C:\path\to\model_skims\network_los.yaml

  - dir: path\to\activitysim\output\run2
    label: Build
    # file_map:
    #   households: household
    #   persons: person
    #   tours: tour
    #   trips: trip_linked
    #   joint_tour_participants: joint_tour_participants
    #   land_use: land_use
    # prepared_table_map:
    #   households: path\to\prepared\households.parquet
    #   persons: path\to\prepared\persons.parquet
    #   tours: path\to\prepared\tours.parquet
    #   trips: path\to\prepared\trips.parquet
    #   joint_tour_participants: path\to\prepared\joint_tour_participants.parquet
    #   land_use: path\to\prepared\land_use.parquet

# ---------------------------------------------------------------------------
# Zone system
# Set use_maz: false for TAZ-only models.
# ---------------------------------------------------------------------------
zones:
  use_maz: false
  maz_col: zone_id
  taz_col: TAZ

# ---------------------------------------------------------------------------
# Column names in the ActivitySim output files
# Alias-capable fields may be a single string or an ordered list of candidates.
# ---------------------------------------------------------------------------
columns:
  ptype: ptype
  hhsize: hhsize
  auto_ownership: auto_ownership
  num_workers: num_workers
  num_adults: num_adults
  # sample_rate: sample_rate
  # household_id: [household_id, hh_id]
  # person_id: [person_id, pid]
  # tour_id: [tour_id, tid]
  # trip_id: [trip_id, tripid]
  # tour_purpose: [tour_purpose, primary_purpose, purpose]
  # trip_purpose: [trip_purpose, purpose]
  # tour_mode: [tour_mode, mode]
  # trip_mode: [trip_mode, mode]


# ---------------------------------------------------------------------------
# Settings for the `prepare` step.
# ---------------------------------------------------------------------------
prepare:
  output:
    file_format: parquet # parquet | csv
  validation:
    relationship_checks: warn # off | warn | error
  distance_skim:
    file: path\to\skims.omx
    matrix: SOV_DIST__MD
  # auto_sufficiency_basis: licensed_drivers # licensed_drivers | workers | adults
  # vot_bins:
  #   source_column: income_segment
  #   output_column: vot_bin
  #   fallback_value: M
  #   mappings:
  #     base:
  #       1: L
  #       2: M
  #       3: H

# ---------------------------------------------------------------------------
# Settings for the `skimjoin` step, to be used as defaults.
# ---------------------------------------------------------------------------
skimjoin:
  defaults:
    config_path: configs/example_skimjoin.yaml
    skim_files:
      - C:\path\to\model_skims\*.omx
      - C:\path\to\model_skims\maz_stop_walk.csv
      - C:\path\to\model_skims\maz_maz_walk.csv
    network_los_file: C:\path\to\model_skims\network_los.yaml

# ---------------------------------------------------------------------------
# Settings for the `segment` step. 
# ---------------------------------------------------------------------------
segment:
  dashboard:
    segmentation_type: person_sex
    visibility: segments_only   # full_only | segments_only | full_and_segments
  definitions:
    signup_platform:
      include_full: true
      persist_segmented_prepared_tables: false
      allow_overlapping: false
      on_empty_segment: warn
      source:
        type: prepared_column 
        source_table: hh
        column: signup_platform
      segments:
        - id: rmove
          label: RMove
          values: ["rmove"]
        - id: browser
          label: Browser
          values: ["browser"]
        - id: call
          label: Call
          values: ["call"]

# ---------------------------------------------------------------------------
# Settings for the `summarize` step.
# ---------------------------------------------------------------------------
summarize:
  weighting_modes: [weighted, unweighted]
  pnr_tour_modes:
    - PNR_TRANSIT
  geography:
    enabled: false
    # landuse_col: COUNTY
    # mapping:
    #   1: County 1
    # aggregations:
    #   district:
    #     source_zone_system: maz
    #     file: C:\path\to\land_use.csv
    #     zone_id_col: MAZ
    #     geography_col: DISTRICT

# ---------------------------------------------------------------------------
# Settings for the `dashboard` step.
# ---------------------------------------------------------------------------
dashboard:
  title: "ActivitySim Comparison Visualizer"
  enable_maz_geographies: false
  live:
    pages:
      - overview
      - long_term_choices
      - daily_travel
      - joint_travel
      - tour_summaries
      - trip_summaries
      - validation
  export:
    output_path: exports/dashboard.html
    # dashboard:
    #   weighting: [unweighted]
    # pages:
    #   long_term_choices:
    #     shadow_pricing:
    #       geography_level: [all]
    #       student_type: [all]
    #       parts:
    #         workplace_table:
    #           enabled: false
    #         school_table:
    #           enabled: false

display:
  labels:
    person_type:
      mapping:
        all_person_types: All Person Types
        1: Full-time worker
        2: Part-time worker
        3: University student
        4: Non-worker adult
        5: Retired
        6: Driving-age student
        7: Non-driving-age student
        8: Preschool

    geography:
      mapping:
        all_geographies: All Geographies
        county: County

    tour_purpose:
      mapping:
        all_tour_purposes: All Tour Purposes
        work: Work
        school: School
        escort: Escort
        shopping: Shopping
        othmaint: Other Maintenance
        eatout: Eat Out
        social: Social
        othdiscr: Other Discretionary
        atwork: At-Work
        joint: Joint

    mode:
      mapping:
        SOV: Drive Alone
        HOV2: Shared Ride 2
        HOV3: Shared Ride 3+
        WALK: Walk
        BIKE: Bike
        WALK_TRANSIT: Walk-Transit
        PNR_TRANSIT: PNR-Transit
        KNR_TRANSIT: KNR-Transit
        TNC_SINGLE: TNC-Single
        TNC_SHARED: TNC-Pool

  run_colors:
    - "#298c8c"
    - "#a00000"
    - "#b8b8b8"
    - "#384860"
    - "#ff7f0e"