PolicyEngine / PolicyEngine/python-package-docs

Update docs away from split policyengine-us-data state H5 example

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
20m
Merged PRs (30d)
1

Description

PolicyEngine/populace#237 removed release generation for one-file-per-state and one-file-per-district artifacts. The replacement path is the single certified Populace national H5 plus the standard region/scoping machinery in policyengine.py, not direct hf://policyengine/policyengine-us-data/states/... or districts/... files.

GitHub code search still finds split-H5 references in this repo:

  • src/app/page.jsx

Migration checklist:

  • Stop constructing or documenting policyengine-us-data/states/*.h5 and policyengine-us-data/districts/*.h5 dataset URIs.
  • Use the certified Populace default dataset through policyengine.py, with region filters/scoping for state and congressional-district analyses.
  • Add or update a regression test so future state/CD runs do not depend on split regional H5 files.
  • Keep historical/generated output unchanged unless it is actively used by the app or docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/app/page.jsx and inspect how it constructs or documents state and congressional-district H5 URIs. Read the policyengine.py region/scoping path, then add or update a regression test covering state and congressional-district runs. Done means active app or documentation references use the certified national Populace dataset rather than split regional H5 files.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, testing, web-dev
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
67/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.