PolicyEngine / PolicyEngine/microcosm

Add a Populace US poverty/SPM diagnostic gate for resource distribution and negative-income tails

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

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
0
Forks
4
Avg merge
1d 3h
Merged PRs (30d)
94

Description

Problem

Populace needs a US validation diagnostic for the SPM/resource distribution failure modes we are investigating. These should be diagnostics, not calibration hard targets.

The diagnostic should report:

  • SPM poverty rate, population count, and subgroup rates from the Populace artifact under current PolicyEngine-US.
  • Resource distribution diagnostics: median/quantiles of SPM resources and relevant subgroup cuts.
  • Negative-resource diagnostics: minimum SPM-unit resources, count/share with negative resources, total negative mass, and largest contributing variables where available.
  • Validation metadata for official/public SPM references and raw CPS reproduction checks where feasible.
  • Target residual context from source-backed hard-target families once the source coverage work lands.

Guardrails

  • Do not make Census CPS SPM, DINA, or ACS poverty rates hard calibration targets.
  • Treat this as a release validation diagnostic/gate; the artifact should publish the numbers and reference identity.
  • Do not persist computed SPM outputs as inputs just to pass diagnostics.

Acceptance criteria

  • A reproducible command/test can produce a structured poverty_spm_diagnostics.json or equivalent release artifact.
  • The diagnostic includes version/reference metadata for PolicyEngine-US, the Populace artifact, and validation references.
  • Tests cover negative-resource summary math, validation-only classification, and a small fixture with known poverty/resource results.
  • Release manifest or diagnostics index links to the poverty/SPM diagnostic artifact.

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 by locating the release manifest or diagnostics index and the existing artifact or command used for validation. Define the structured poverty_spm_diagnostics.json output around the listed SPM, resource-distribution, negative-resource, and reference metadata requirements. Add tests for negative-resource summary math, validation-only classification, and the small known-results fixture, then link the artifact from the release manifest or diagnostics index.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, release, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.