Documentation

Getting started

• Install from PyPI
• Install from Git
• Running Tests
• Smoke test with sample data

Build a jurisdiction from scratch (tutorial)

• Smoke test with sample data
• Onboard your own jurisdiction

The basics

• Creating a new locality
• Code modules
• Jupyter Notebooks
• Terminology

Configuration

• Cloud storage
• PDF report generation
• US Census API
• Open Street Map API

Advanced settings reference

• The settings.json preprocessor — comments, $$ references, template merging, ! and + flags
• Data load: data.load.<id> — dupes rules and per-field aggregation across duplicate rows
• Time adjustment overrides
• Data enrichment toggles
• Data cleaning & validation
• Modeling control
• Analysis & QA
• Caching & checkpoints — when self-invalidation is enough, and when to nuke the cache

The calc expression language

• Where calc is used
• Expression syntax
• Operator reference
• Worked examples
• Tweaks

Models reference

• How model invocation works — name vs engine, multi-variant runs, the default entry
• Common entry fields
• Engine reference — predictive models, reference / pass-through, naive baselines, ensemble
• Worked example: ablation study