Skip to main content

Redistricting ensembles

Project description

rdaensemble

Redistricting ensembles

Methods

The code in this repository supports several methods for generating ensembles of redistricting plans (maps):

  • Random maps from random spanning trees (RMfRST)
  • Random maps from random starting points (RMfRSP)
  • Ensemble of maps using MCMC/ReCom (ReCom)
  • Ensemble of maps using Sequential Monte Carlo (SMC) <<< TODO

Input Files

The inputs for generating & scoring ensembles are:

from rdascore import load_data, load_shapes, load_graph, load_metadata

data: Dict[str, Dict[str, int | str]] = load_data(data_path)
shapes: Dict[str, Any] = load_shapes(shapes_path)
graph: Dict[str, List[str]] = load_graph(graph_path)
metadata: Dict[str, Any] = load_metadata(state_code, data_path)

The precinct data, shapes, and graphs are all available in the companion repository rdatools/rdabase in the data directory by state. They are named NC_2020_data.csv, NC_2020_shapes_simplified.json, and NC_2020_graph.json, for example.

Theoretically, these inputs can come from any source, but for simplicity, reproducibility, and apples-to-apples comparisons, it's best to use the input files in rdabase.

Output Files

Ensembles are saved as JSON files. A file contains metadata about the ensemble, including the method used to generate it, and then a plans key with a list of plans:

plans: List[Dict[str, str | float | Dict[str, int | str]]]

Each plan item has a name (str), an optional weight (float), and a plan (Dict[str, int | str]]) which represents the assignments as geoid: district_id key: value pairs.

Scores for the plans in an ensemble are saved as a CSV file, with one row per plan and one column per metric. The metrics are the same as those produced by rdatools/rdascore, except they also include the energy of the plan. The metric names are descriptive.

When a scores CSV file is produced, a companion JSON file with metadata about the scoring is also generated.

Naming Conventions

You can name ensemble and score files anything you want. To facilitate understanding the contents of these files without having to open them, we recommend the following the convention:

  • Ensemble example: NC20C_RMfRST_1000_plans.json
  • Scores example: NC20C_RMfRST_1000_scores.csv

where "NC" is the state code, "20" stands for the 2020 census cycle, "C" abbreviates "Congress" (as opposed to state upper or lower house), "RMfRST" is the method, 1000 is the number of plans in the ensemble, and "plans" and "scores" distinguish between the two types of files.

Note: The scores metadata file will be named the same as the scores file, except it will end _metadata.json instead of .csv, for example, NC20C_RMfRST_1000_scores_metadata.json.

Usage

To generate an ensemble of 1,000 plans using the random maps from random spanning trees method (RMfRST), run:

scripts/rmfrst_ensemble.py \
--state NC \
--data ../rdabase/data/NC/NC_2020_data.csv \
--shapes ../rdabase/data/NC/NC_2020_shapes_simplified.json \
--graph ../rdabase/data/NC/NC_2020_graph.json \
--size 1000 \
--plans ~/iCloud/fileout/ensembles/NC20C_RMfRST_1000_plans.json \
--log ~/iCloud/fileout/ensembles/NC20C_RMfRST_1000_log.txt \
--no-debug

To score the resulting ensemble, run:

scripts/score_ensemble.py \
--state NC \
--plans ~/iCloud/fileout/ensembles/NC20C_RMfRST_1000_plans.json \
--data ../rdabase/data/NC/NC_2020_data.csv \
--shapes ../rdabase/data/NC/NC_2020_shapes_simplified.json \
--graph ../rdabase/data/NC/NC_2020_graph.json \
--scores ~/iCloud/fileout/ensembles/NC20C_RMfRST_1000_scores.csv \
--no-debug

To generate random maps from random starting points (RMfRSP) instead, use the rmfrst_ensemble.py script. For ReCom, use the recom_ensemble.py script.

Note: Ensemble JSON files can be quite large, bigger than GitHub's 100 MB file size limit, so we recommend that you write them to the ensembles directory, which is ignored by Git.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rdaensemble-1.1.1.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

rdaensemble-1.1.1-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file rdaensemble-1.1.1.tar.gz.

File metadata

  • Download URL: rdaensemble-1.1.1.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for rdaensemble-1.1.1.tar.gz
Algorithm Hash digest
SHA256 24a199bd822adfc1e1f5a87c5827f077f5ae33f0551e31e5d425cdca750725b2
MD5 1feb5d9c25b1beee386d877c9fb5d098
BLAKE2b-256 4c1ad3dc05c7987d2395f083fca2675465b72c147cb61d32bbf9d1c317c5ebb0

See more details on using hashes here.

File details

Details for the file rdaensemble-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: rdaensemble-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for rdaensemble-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 baf986a569eaa0290e67d4c8e2086ad96d65926dded4bee93270da305130885a
MD5 f6df03934ad636470d4c367434cd9d48
BLAKE2b-256 35795fbca3ced620a6ad5d353bcaa585a94761b504ce588a7f43f1b92378dd8c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page