PolicyEngine / PolicyEngine/policyengine.py

README population quickstart still teaches enhanced_frs_2023_24

Open Beginner friendly
#473 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7
Forks
9
Avg merge
15h 51m
Merged PRs (30d)
9

Description

The README's "Population analysis" quickstart passes datasets=["enhanced_frs_2023_24"] to pe.uk.ensure_datasets and reads datasets["enhanced_frs_2023_24_2026"], but the certified UK default since bundle 4.18+ is populace_uk_2023 (private HF repo, HUGGING_FACE_TOKEN). Found while rebuilding policyengine-skills (PolicyEngine/policyengine-skills#61), whose skills now teach the Populace names — the README is the remaining place pointing newcomers at the superseded dataset.

Suggested fix: default the example to pe.us (public data, runs without a token) or update the UK example to populace_uk_2023 with the token note.

🤖 Generated with Claude Code

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 the README's "Population analysis" quickstart and inspect how it passes datasets to pe.uk.ensure_datasets and reads the resulting dataset. Run the quickstart to check the chosen public or token-authenticated example. Done means the example no longer teaches enhanced_frs_2023_24 and matches the supported dataset guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.