GerryChain
User Guide
Overview of the Chain
Installation
Getting started with GerryChain
Running a chain with ReCom
Working with Partitions
Updaters
Good Data Practices
Working With Geometries
Optimization Methods of GerryChain
Advanced Example: Optimizing Using Geographic Quantities
API Reference
API Reference
Topics
Reproducibility
Evaluating districting plans in the real world
Contributing to GerryChain
Reporting Issues
Index
Full Package Reference
GerryChain
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
Acceptance functions
add_data() (gerrychain.graph.graph.Graph method)
add_edge() (gerrychain.graph.graph.Graph method)
B
BalanceError
bipartition_tree() (in module gerrychain.tree)
bipartition_tree_random() (in module gerrychain.tree)
bipartition_tree_random_with_num_cuts() (in module gerrychain.tree)
BipartitionWarning
boundary_nodes() (in module gerrychain.updaters)
Bounds (class in gerrychain.constraints)
C
collect_diversity_stats() (in module gerrychain.meta.diversity)
compute_edge_flows() (in module gerrychain.updaters)
constraints (gerrychain.MarkovChain property)
contiguous() (in module gerrychain.constraints)
contiguous_bfs() (in module gerrychain.constraints)
convert_from_nx_to_rx() (gerrychain.graph.graph.Graph method)
count() (gerrychain.updaters.election.ElectionResults method)
counts() (gerrychain.updaters.election.ElectionResults method)
county_splits() (in module gerrychain.updaters)
CountySplit (class in gerrychain.updaters)
crosses_parts() (gerrychain.partition.Partition method)
Cut (class in gerrychain.tree)
cut_edges() (in module gerrychain.updaters)
cut_edges_by_part() (in module gerrychain.updaters)
D
DataTally (class in gerrychain.updaters)
degree() (gerrychain.graph.graph.Graph method)
deviation_from_ideal() (in module gerrychain.constraints)
districts_within_tolerance() (in module gerrychain.constraints)
DiversityStats (class in gerrychain.meta.diversity)
E
edge (gerrychain.tree.Cut attribute)
edge_data() (gerrychain.graph.graph.Graph method)
edge_indices (gerrychain.graph.graph.Graph property)
edges (gerrychain.graph.graph.Graph property)
efficiency_gap() (gerrychain.updaters.election.ElectionResults method)
(in module gerrychain.metrics)
Election (class in gerrychain.updaters)
(class in gerrychain.updaters.election)
ElectionResults (class in gerrychain.updaters.election)
ElectionUpdater (class in gerrychain.updaters.election)
epsilon_tree_bipartition() (in module gerrychain.tree)
exterior_boundaries() (in module gerrychain.updaters)
exterior_boundaries_as_a_set() (in module gerrychain.updaters)
F
find_balanced_edge_cuts_contraction() (in module gerrychain.tree)
find_balanced_edge_cuts_memoization() (in module gerrychain.tree)
flip() (gerrychain.partition.Partition method)
flips() (in module gerrychain.updaters)
flows_from_changes() (in module gerrychain.updaters)
format_part_results() (in module gerrychain.updaters.election)
from_districtr_file() (gerrychain.partition.Partition class method)
from_file() (gerrychain.graph.graph.Graph class method)
from_geodataframe() (gerrychain.graph.graph.Graph class method)
from_json() (gerrychain.graph.graph.Graph class method)
from_networkx() (gerrychain.graph.graph.Graph class method)
from_random_assignment() (gerrychain.partition.Partition class method)
from_rustworkx() (gerrychain.graph.graph.Graph class method)
G
generic_bfs_edges() (gerrychain.graph.graph.Graph method)
generic_bfs_predecessors() (gerrychain.graph.graph.Graph method)
generic_bfs_successors() (gerrychain.graph.graph.Graph method)
generic_bfs_successors_generator() (gerrychain.graph.graph.Graph method)
GeographicPartition (class in gerrychain.partition)
gerrychain
module
gerrychain.constraints
module
gerrychain.meta.diversity
module
gerrychain.metrics
module
gerrychain.partition
module
gerrychain.proposals
module
gerrychain.tree
module
gerrychain.updaters
module
gerrychain.updaters.election
module
get_edge_from_edge_id() (gerrychain.graph.graph.Graph method)
get_edge_id_from_edge() (gerrychain.graph.graph.Graph method)
get_max_prime_factor_less_than() (in module gerrychain.tree)
get_nx_graph() (gerrychain.graph.graph.Graph method)
get_nx_to_rx_node_id_map() (gerrychain.graph.graph.Graph method)
get_percents() (in module gerrychain.updaters.election)
get_previous_values() (gerrychain.updaters.election.ElectionUpdater method)
get_rx_graph() (gerrychain.graph.graph.Graph method)
Graph (class in gerrychain.graph.graph)
Grid (class in gerrychain.grid)
H
has_ideal_population() (gerrychain.tree.PopulatedGraph method)
I
interior_boundaries() (in module gerrychain.updaters)
internal_node_id_for_original_nx_node_id() (gerrychain.graph.graph.Graph method)
is_a_tree() (gerrychain.graph.graph.Graph method)
is_nx_graph() (gerrychain.graph.graph.Graph method)
is_rx_graph() (gerrychain.graph.graph.Graph method)
islands (gerrychain.graph.graph.Graph property)
issue_warnings() (gerrychain.graph.graph.Graph method)
J
join() (gerrychain.graph.graph.Graph method)
L
L1_polsby_popper() (in module gerrychain.constraints)
L1_reciprocal_polsby_popper() (in module gerrychain.constraints)
L2_polsby_popper() (in module gerrychain.constraints)
L_minus_1_polsby_popper() (in module gerrychain.constraints)
laplacian_matrix() (gerrychain.graph.graph.Graph method)
LowerBound (class in gerrychain.constraints)
M
MarkovChain (class in gerrychain)
mean_median() (gerrychain.updaters.election.ElectionResults method)
(in module gerrychain.metrics)
mean_thirdian() (gerrychain.updaters.election.ElectionResults method)
module
gerrychain
gerrychain.constraints
gerrychain.meta.diversity
gerrychain.metrics
gerrychain.partition
gerrychain.proposals
gerrychain.tree
gerrychain.updaters
gerrychain.updaters.election
N
neighbors() (gerrychain.graph.graph.Graph method)
no_vanishing_districts() (in module gerrychain.constraints)
node_data() (gerrychain.graph.graph.Graph method)
node_indices (gerrychain.graph.graph.Graph property)
nodes (gerrychain.graph.graph.Graph property)
normalized_laplacian_matrix() (gerrychain.graph.graph.Graph method)
num_connected_components() (gerrychain.graph.graph.Graph method)
num_spanning_trees() (in module gerrychain.updaters)
O
original_nx_node_id_for_internal_node_id() (gerrychain.graph.graph.Graph method)
original_nx_node_ids_for_list() (gerrychain.graph.graph.Graph method)
original_nx_node_ids_for_set() (gerrychain.graph.graph.Graph method)
P
partisan_bias() (gerrychain.updaters.election.ElectionResults method)
(in module gerrychain.metrics)
partisan_gini() (gerrychain.updaters.election.ElectionResults method)
(in module gerrychain.metrics)
Partition (class in gerrychain.partition)
percent() (gerrychain.updaters.election.ElectionResults method)
percents() (gerrychain.updaters.election.ElectionResults method)
perimeter() (in module gerrychain.updaters)
plot() (gerrychain.partition.Partition method)
polsby_popper() (in module gerrychain.metrics)
PopulatedGraph (class in gerrychain.tree)
PopulationBalanceError
predecessors() (gerrychain.graph.graph.Graph method)
Proposals
propose_chunk_flip() (in module gerrychain.proposals)
propose_random_flip() (in module gerrychain.proposals)
R
random_spanning_tree() (in module gerrychain.tree)
recom() (in module gerrychain.proposals)
recursive_seed_part() (in module gerrychain.tree)
recursive_tree_part() (in module gerrychain.tree)
refuse_new_splits() (in module gerrychain.constraints)
ReselectException
reversible_recom() (in module gerrychain.proposals)
S
seats() (gerrychain.updaters.election.ElectionResults method)
SelfConfiguringLowerBound (class in gerrychain.constraints)
SelfConfiguringUpperBound (class in gerrychain.constraints)
single_flip_contiguous() (in module gerrychain.constraints)
spectral_recom() (in module gerrychain.proposals)
subgraph() (gerrychain.graph.graph.Graph method)
subgraphs_for_connected_components() (gerrychain.graph.graph.Graph method)
subset (gerrychain.tree.Cut attribute)
successors() (gerrychain.graph.graph.Graph method)
T
Tally (class in gerrychain.updaters)
tally_region_splits() (in module gerrychain.updaters)
to_json() (gerrychain.graph.graph.Graph method)
to_networkx_graph() (gerrychain.graph.graph.Graph method)
total_votes() (gerrychain.updaters.election.ElectionResults method)
translate_subgraph_node_ids_for_flips() (gerrychain.graph.graph.Graph method)
translate_subgraph_node_ids_for_set_of_nodes() (gerrychain.graph.graph.Graph method)
U
uniform_spanning_tree() (in module gerrychain.tree)
Updaters
UpperBound (class in gerrychain.constraints)
V
Validator (class in gerrychain.constraints)
Validators
verify_graph_is_valid() (gerrychain.graph.graph.Graph method)
votes() (gerrychain.updaters.election.ElectionResults method)
W
warn_for_islands() (gerrychain.graph.graph.Graph method)
wasted_votes() (in module gerrychain.metrics)
weight (gerrychain.tree.Cut attribute)
wins() (gerrychain.updaters.election.ElectionResults method)
with_progress_bar() (gerrychain.MarkovChain method)
within_percent_of_ideal_population() (in module gerrychain.constraints)
WithinPercentRangeOfBounds (class in gerrychain.constraints)
won() (gerrychain.updaters.election.ElectionResults method)