Improve area targeting documentation for users#512
Merged
Conversation
Restructure tmd/areas/README.md as the user front door for the area- weighting pipeline; rewrite tmd/areas/weights/README.md from scratch to document weight-file format, the per-area solver log, and the all-areas quality_report_per_area.csv summary; explain how to use weight files with or without Tax-Calculator. Add a "Sub-national area weights" section to the top-level README and turn the "areas" bullet in tmd/README.md into a link. Drop references to the retired Quarto/Netlify documentation sites and replace them with in-repo cross-links. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The pandas example used WT2024 with TMD's stored e00200 values, which are in TMD-base-year (2022) dollars. The product is "2022 wages valued at California's 2024 weights" rather than CA wages in 2024 — a year-mismatch trap for an introductory example. Switch to WT2022 so weight year and value year match, and add a short note that later years require aging via growfactors or use of the cached Tax-Calculator outputs covered in the next section. Verified: (tmd["e00200"] * wts["WT2022"]).sum() = \$1,371.9B, consistent with BEA's California wage scale for 2022. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
donboyd5
added a commit
to donboyd5/tax-microdata-benchmarking
that referenced
this pull request
Apr 26, 2026
donboyd5
added a commit
to donboyd5/tax-microdata-benchmarking
that referenced
this pull request
Apr 26, 2026
…SLmodels#513), branches pruned
This was referenced Apr 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
First of two PRs for issue #506. Improves the user-facing
documentation for area target creation and area weight optimization.
Developer-facing improvements (AREA_WEIGHTING_GUIDE.md restructure,
LESSONS update, module docstrings) come in a separate PR.
what a user wants to do (build all states, build all CDs, re-solve
one area, run a quality report on many areas, run one on a single
area, or run single-area diagnostics).
stages need rerunning when the TMD national file, SOI vintage,
recipe, or solver parameters change.
quality_report_per_area.csv output (covers every area, no
truncation for CDs).
covering weight-file naming, columns, solver-log contents, and
a worked example for computing weighted area totals — both with
pandas alone and inside Tax-Calculator.
section pointing into tmd/areas/.
(tmd-areas-prepare-{state,cd}-targets.netlify.app) are no longer
referenced; replaced with in-repo cross-links.
Test plan
(tmd["e00200"] * wts["WT2022"]).sum()forpandas and the Records sketch for Tax-Calculator).