Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 12, 2024
1 parent 534b9cc commit 44e9158
Show file tree
Hide file tree
Showing 61 changed files with 715 additions and 20 deletions.
Binary file modified _images/gingleator_maxes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions _modules/functools.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/accept.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/chain.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/constraints/bounds.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/constraints/compactness.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/constraints/contiguity.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/constraints/validity.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/graph/adjacency.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/graph/geo.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/graph/graph.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/grid.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/meta/diversity.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/metagraph.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/metrics/compactness.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/metrics/partisan.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/optimization/gingleator.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/optimization/optimization.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/partition/assignment.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/partition/geographic.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/partition/partition.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/partition/subgraphs.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/proposals/proposals.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/proposals/spectral_proposals.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/proposals/tree_proposals.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/updaters/compactness.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/updaters/county_splits.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/updaters/cut_edges.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/updaters/election.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/updaters/flows.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
1 change: 1 addition & 0 deletions _modules/gerrychain/updaters/locality_split_scores.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../user/data.html">Good Data Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometries.html">Working With Geometries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/optimizers.html">Optimization Methods of GerryChain</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../user/geometric_optimizers.html">Advanced Example: Optimizing Using Geographic Quantities</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
Expand Down
Loading

0 comments on commit 44e9158

Please sign in to comment.