API reference

The API reference is organized by the public module from which users import an object. The user guides explain workflows and tradeoffs; these pages provide signatures, parameter contracts, return types, and the detailed behavior recorded in docstrings.

Core workflow modules

Data

Census, ACS, and CVAP retrieval plus processed 2020 geographic downloads.

Data retrieval and processing
Plan comparison

Population and area overlap, dispersion, and optimal district relabeling.

Plan comparison
Scoring

Scoring-engine plan evaluation and array-based derived scores.

Scoring
Plotting

Plot builders, option dataclasses, and Matplotlib style objects.

Plotting
MGRP

Docker-backed ReCom, Forest, and SMC runners with constraints and objectives.

MGRP ensemble runners
BEN

Record GerryChain runs as self-describing BENDL ensemble files.

BEN chain recording
LaTeX

TeX documents, tables, formatters, and TeX-native plot builders.

LaTeX output

Supporting modules

Colors

Named palettes, color resolution, and districtr color utilities.

Colors