This wiki is the main documentation home for the ActivitySim Visualizer. It is written for two audiences:
- users who need to run the visualizer on ActivitySim outputs
- developers who need to extend the processor, summaries, skimjoin, or dashboard
The short mental model:
ActivitySim outputs
-> Output Processor
-> prepared tables and summary caches
-> Output Visualizer
-> live dashboard or standalone HTML export
For the subsystem boundaries and complete repository map, see 01 - Architecture.
You only need three short chapters for normal use:
- Get a dashboard running.
- Choose raw, prepared, or summary inputs.
- Configure a live, export, or processor workflow.
Use Troubleshooting when something is missing. The Configuration Reference is there when you need an exact field or default; it is not required reading.
| If you want to... | Read |
|---|---|
| Find every main config field and option | 13 - Configuration Reference |
| Understand the Output Processor | 20 - Output Processor |
| Add a prepared column | 41 - Data Extension Cookbook |
| Add or debug skimjoin outputs | 22 - Skimjoin |
| Find every skimjoin config field and lookup option | 25 - Skimjoin Config Reference |
| Add a summary function | 44 - Summary Function Cookbook |
| Find every registered summary table | 24 - Summary Catalog |
| Understand the Output Visualizer | 30 - Output Visualizer |
| Add a dashboard page or page group | 45 - Dashboard Extension Cookbook |
| Add a figure, table, selector, or widget | 45 - Dashboard Extension Cookbook |
| Add an outside summary, prepared column, or prepared table | 41 - Data Extension Cookbook |
| Add a config item, column alias, or label mapping | 42 - Config, Columns, and Labels |
| Add a weighting mode or hosting adapter | 43 - Weighting and Hosting Extensions |
| Debug an empty page, bad cache, or export mismatch | 90 - Troubleshooting |
- 01 - Architecture
- 10 - Getting Started
- 11 - Configuring Your Data
- 12 - Running Workflows
- 13 - Configuration Reference
- 20 - Output Processor
- 21 - Prepared Tables
- 22 - Skimjoin
- 23 - Summary Functions
- 24 - Summary Catalog
- 25 - Skimjoin Config Reference
- 30 - Output Visualizer
- 31 - Dashboard Pages
- 32 - Figures and Widgets
- 33 - Dashboard Page Recipes
- 34 - HTML Export
- 40 - Developer Workflows
- 41 - Data Extension Cookbook
- 42 - Config, Columns, and Labels
- 43 - Weighting and Hosting Extensions
- 44 - Summary Function Cookbook
- 45 - Dashboard Extension Cookbook
- 46 - Testing
- 90 - Troubleshooting
- 99 - Glossary
Some wiki sections are generated from code to keep reference material from drifting:
- 24 - Summary Catalog
- the generated page catalog in 31 - Dashboard Pages
Regenerate them after changing summary declarations/contracts, dashboard page definitions, or page data requirements:
uv run python scripts/generate_wiki_catalogs.py