API Reference¶
The public API is divided by the role each component plays in a GerryChain workflow.
Core structures¶
Graphs
Geographic units and their adjacency relationships.
Partitions
District assignments and plan statistics.
Markov chains
Chain configuration, iteration, and state transitions.
Building chains¶
Proposals and constraints
Candidate plans and the rules used to validate them.
Updaters and elections
Derived statistics, election results, and incremental updates.
Utilities and analysis¶
Grids and spanning trees
Synthetic grids and tree-based partitioning tools.
Metrics and diversity
Compactness, partisan statistics, and ensemble diversity.