Skip to main content

Redistricting ensembles

Project description

rdaensemble

Redistricting ensembles

Installation

To clone the repository:

$ git clone https://github.com/rdatools/rdaensemble
$ cd rdaensemble

To run the scripts, install the dependencies:

pip install -r requirements.txt

To install the package in another project:

$ pip install rdaensemble

Usage

To generate an ensemble of plans, use one of the *_ensemble.py scripts:

  • rmfrst_ensemble.py for Random Maps from Random Spanning Trees (RMfRST)
  • rmfrsp_ensemble.py for Random Maps from Random Starting Points (RMfRSP)
  • recom_ensemble.py for ReCom

There are example calls in each file. Note: The resulting ensemble JSON files can be quite large--bigger than GitHub's 100 MB file size limit-- so we recommend that you write them to a directory which is not under source control.

To score the plans in an ensemble, use the score_ensemble.py script.

The other scripts are specific to our "trade-offs in redistricting" project and are not generally useful.

Notes

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.

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.

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.8.0.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

rdaensemble-1.8.0-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rdaensemble-1.8.0.tar.gz
Algorithm Hash digest
SHA256 b31f13b5e979c76191bc23b11d9efc69860045907940e14fe210e7599f004a08
MD5 0adc16ee576f4aa6a5511c4a7c4ea8db
BLAKE2b-256 2d5932136ef1b5c554eac109f7583b02e4d214d0276368823f12dd2921b637b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rdaensemble-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 23.0 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67fb5def375fca9515e972e58485aaf8d8dcbec45c547c96a1b5d2719d15bff1
MD5 2e8df1e370ccd1893d0359b4767d9d9e
BLAKE2b-256 99f34885d2086a8aaae5cdfc2039949f792483a23abe4d87617f93faf12e8cfa

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