Skip to content

AGENTS.md

Latest commit

 

History

History
38 lines (27 loc) · 3.12 KB

AGENTS.md

File metadata and controls

38 lines (27 loc) · 3.12 KB

Agent Guidance

This document provides guidance for AI agents working on this project.

Project Overview

This project is a congressional redistricting application that automatically generates district maps based on user-provided criteria. The application is built using Python, with PyQt5 for the GUI and GeoPandas for geographic data manipulation.

Key Modules

  • main.py: The main entry point of the application. It contains the MainWindow class, which defines the GUI and orchestrates the overall workflow.
  • data_fetcher.py: This module is responsible for fetching the initial state population data for apportionment calculations.
  • redistricting_algorithms.py: This module contains the implementation of the redistricting algorithms, including the "Divide and Conquer" algorithm and the gerrymandering algorithm.
  • map_generator.py: This module is responsible for generating map images and exporting district data to shapefiles.
  • apportionment.py: This module contains the logic for the Huntington-Hill apportionment method.
  • worker.py: This module contains the DataFetcherWorker class, which runs the data fetching process in a separate QThread to prevent the GUI from freezing.
  • redistricting_worker.py: This module contains the RedistrictingWorker class, which runs the redistricting algorithm in a separate QThread.

Development Guidelines

  • Code Style: Please follow the PEP 8 style guide for Python code.
  • Modularity: Keep the code modular and well-organized. Each module should have a clear and specific purpose.
  • Error Handling: Implement robust error handling, especially for network requests and file operations.
  • Testing: While there are no automated tests at the moment, it is highly encouraged to add them in the future.

Implemented Enhancements

  • Huntington-Hill Apportionment: The application now allows users to set the total size of the U.S. House of Representatives and uses the Huntington-Hill method to apportion districts to each state.
  • VRA Compliance Logic: The VRA compliance logic has been implemented in the redistricting algorithms to prevent the "cracking" of minority communities.
  • Enhanced Gerrymandering Algorithm: The gerrymandering algorithm has been enhanced to use a partisan score to create a partisan advantage.
  • Support for Communities of Interest: The application now supports the preservation of communities of interest by allowing users to upload a CSV file of GEOIDs.
  • Expanded State List: The state selection dropdown is now populated with a complete list of US states.
  • Performance Optimization: The redistricting algorithm has been parallelized to improve performance on multi-core systems.
  • Progress Bar: A progress bar has been added to the GUI to provide feedback during the data fetching and redistricting processes.

API Usage Notes

  • Census API for Block-Level Data: When fetching block-level data from the Census API, it is required to specify both the state and county FIPS codes. A request for all blocks within a state will not work without also specifying a county.