From 94780237d2a373e059d1361137bf65001993afd3 Mon Sep 17 00:00:00 2001 From: martinholmer Date: Thu, 13 Aug 2026 09:26:33 -0400 Subject: [PATCH] Add state weights documentation to README.md --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d86108b4..8c2d4fc9 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ or higher is required to generate the TMD files. When using version 2.1.4 to generate **sub-national weights**, there will be (presumably small) differences from the sub-national weights -generated using earlier versions; however, the sub-national weights -fingerprints have not yet been updated. +generated using earlier versions; however, the Congressional district +weights fingerprints have not yet been updated. The earlier TMD 2.0.0 version introduced the following significant improvements: @@ -75,3 +75,23 @@ values match state-level (or CD-level) totals from IRS Statistics of Income See [`tmd/areas/README.md`](tmd/areas/README.md) for how to build the weights, what files you get, and how to use them — with or without Tax-Calculator. + +Here is how to generate the state weights after executing `make data` +to generate the national files. **First**, generate the state weights +by executing this command in the top-level folder of the repository: + +``` +make -C tmd/areas states WORKERS=8 +``` + +changing the number of workers from 8 to 4 if spare computing power is +needed while this command executes. Report any test errors or other +problems by opening a new issue. **Second**, run the optional state +fingerprint test by executing this command in the top-level folder of +the repository: + +``` +pytest tests/test_fingerprint.py -v -k states +``` + +Report any test errors or other problems by opening a new issue.