policyengine 6.2.3__tar.gz → 6.2.5__tar.gz

{policyengine-6.2.3 → policyengine-6.2.5}/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [6.2.5] - 2026-10-09
+
+### Fixed
+
+- Add opt-in verified US state/year preparation and temporarily assume WIC claiming only for missing participation decisions on identified ACS people, preserving donor decisions and country-model eligibility.
+
+
+## [6.2.4] - 2026-10-09
+
+### Fixed
+
+- UK population runs now anchor the State Pension on the survey year their data was projected from, as policyengine-uk does, so a run of a UK year file matches policyengine-uk on the certified dataset, with or without a reform. Before, it took the projected year as the survey year: the State Pension was uprated by CPI rather than the triple lock, and State Pension rate reforms had no effect on it under policyengine-uk 2.102.3 and were understated under 2.123. Projected year files now also store the survey year's tables, which doubles their size. `ensure_datasets` regenerates year files from earlier releases and `load_datasets` refuses them; `Simulation.load()` refuses UK outputs saved by earlier releases, and `Simulation.ensure()` runs them again.
+
+
 ## [6.2.3] - 2026-10-09
 
 ### Changed

{policyengine-6.2.3/src/policyengine.egg-info → policyengine-6.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 6.2.3
+Version: 6.2.5
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE

policyengine-6.2.5/docs/engineering/runbooks/acs-local-wic-replacement.md

@@ -0,0 +1,56 @@
+# Replace the temporary ACS WIC assumption
+
+## Temporary compatibility fix
+
+The certified local-area release
+`populace-us-2024-buildo-acs-local-767312d60-20260923T074941Z` stores donor
+participation decisions as `would_claim_wic`, with missing decisions on ACS
+people. The current model consumes the monthly person input
+`takes_up_wic_if_eligible`.
+
+The wrapper preserves all valid existing decisions and sets only missing
+decisions on people whose `person_support_channel` is `acs_2024_1yr` to `True`.
+This explicitly assumes that every eligible affected ACS person claims WIC;
+it does not change eligibility. Missing donor decisions, missing identifying
+provenance, and malformed values remain errors. Source H5 files are unchanged.
+
+The existing loader applies this before calculation and year preparation,
+including baseline and reform branches. The fix does not add partitioning,
+state/year preparation APIs, new dataset defaults, or deployment behavior.
+
+## Replacement ownership
+
+[Microcosm #1154](https://github.com/PolicyEngine/microcosm/issues/1154) tracks
+the code repair, a dataset rebuild and publication by a separate dataset owner,
+certification in this repository, and removal of the exception. Merging the
+[code repair](https://github.com/PolicyEngine/microcosm/pull/1156) does not
+publish a replacement population or complete that issue.
+
+The repair generates ACS participation after completing demographic inputs and
+before combining ACS records with donors. It reuses the existing WIC generator,
+preserves donor decisions, writes complete boolean participation inputs, and
+rejects missing decisions. The dataset owner must rebuild the affected outputs
+and satisfy the existing release checks.
+
+## Remove the exception
+
+The separate stacked [removal PR #563](https://github.com/PolicyEngine/policyengine.py/pull/563)
+must remain a draft until the replacement dataset has been published and
+certified. Do not invent its revision or hash or relax its failing check.
+
+Once the replacement is available:
+
+1. Follow the [US certification runbook](build-m-us-populace-certification.md)
+   with its actual immutable regional manifest. Keep national defaults and
+   model pins unchanged unless separately approved.
+2. Verify complete current-name participation on the replacement and record
+   its revision and hashes.
+3. Add the real certification changes to the removal PR and rebase it onto
+   `main` after the temporary compatibility fix merges.
+4. Delete only the ACS missing-value exception. Keep ordinary legacy-name
+   mapping while other certified datasets require it.
+5. Run the focused mapping and country-model integration tests and validate
+   preparation against the actual replacement dataset.
+
+This fix does not rebuild or publish data, deploy services, or introduce
+environment variables or database changes.

{policyengine-6.2.3 → policyengine-6.2.5}/docs/microsim.md

@@ -231,6 +231,45 @@ not need repository-specific download logic. Authentication or authorization
 failures are reported directly and do not cause a retry against another
 repository type.
 
+### UK year files and the data year
+
+`ensure_datasets` and `create_datasets` cut one file per requested year from
+the projection policyengine-uk makes of the certified dataset. policyengine-uk
+takes the first year of a dataset as observed data. Its State Pension formulas
+split each person's reported State Pension against that year's legislated
+rates, and scale the share to the simulated year's rates, which follow the
+triple lock. The projection uprates the reported amount by CPI, so handing a
+projected year's tables to policyengine-uk as observed data would make the
+State Pension follow CPI instead.
+
+Each projected year file therefore keeps its data year, `dataset.data_year`
+(2024 for Enhanced FRS 2024–25), and that year's tables,
+`dataset.data_year_data`. `Simulation.run()` projects the data year's tables
+forward as policyengine-uk does, and uses the file's own tables for the
+simulated year. A run of a year file then gives the same result, record by
+record, as `policyengine_uk.Microsimulation` on the certified file, with or
+without a reform. Keeping the data year's tables doubles a projected file: the
+Enhanced FRS 2026 file is 226 MB, against 113 MB for its own tables. A dataset
+built in memory without a data year is observed data for its own year, which
+is how policyengine-uk treats a single-year dataset.
+
+Row filtering applies to both sets of tables, matched by entity ID. Weight
+replacement changes the simulated year's weights only; the data year and the
+years between keep national weights. A row-filtered run is a simulation of the
+region's households alone, so
+variables that policyengine-uk calculates over every household in the
+simulation are calculated over the region: income deciles, the relative
+poverty median, and `shareholding`, which spreads corporate taxes across
+households (PolicyEngine/policyengine.py#567). Variables of a person or
+benefit unit that do not depend on those match the national run.
+
+Year files written by earlier releases have no recorded data year.
+`ensure_datasets` writes them again and `load_datasets` refuses them. A year
+file opened directly, as `PolicyEngineUKDataset(filepath=...)`, is not
+checked. A saved UK simulation output records the data year its run anchored
+on; `Simulation.load()` refuses an output saved without one, and
+`Simulation.ensure()` runs it again.
+
 ## Simulations
 
 A `Simulation` needs a dataset, a tax-benefit model version, and optionally a policy (reform):

{policyengine-6.2.3 → policyengine-6.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "policyengine"
-version = "6.2.3"
+version = "6.2.5"
 description = "A package to conduct policy analysis using PolicyEngine tax-benefit models."
 readme = "README.md"
 authors = [

{policyengine-6.2.3 → policyengine-6.2.5}/src/policyengine/data/bundle/manifest.json

@@ -1,10 +1,10 @@
 {
-  "bundle_version": "6.2.3",
+  "bundle_version": "6.2.5",
   "citation": {
     "publisher": "PolicyEngine",
-    "title": "PolicyEngine bundle 6.2.3",
+    "title": "PolicyEngine bundle 6.2.5",
     "type": "software-bundle",
-    "version": "6.2.3"
+    "version": "6.2.5"
   },
   "countries": {
     "uk": {
@@ -17,7 +17,7 @@
   "data_releases": {
     "uk": {
       "build_id": "policyengine-uk-data-1.56.16",
-      "bundle_id": "uk-6.2.3",
+      "bundle_id": "uk-6.2.5",
       "certification": {
         "built_with_model_git_sha": "12a1e028afeef08d8b2d74ee03fd9de3a78b2dd3",
         "built_with_model_version": "2.89.2",
@@ -99,7 +99,7 @@
         "version": "2.102.3",
         "wheel_url": "https://files.pythonhosted.org/packages/37/e6/e8d9069d498f1510a1380f24a78e957902d01f00b10248c146d6710d5b37/policyengine_uk-2.102.3-py3-none-any.whl"
       },
-      "policyengine_version": "6.2.3",
+      "policyengine_version": "6.2.5",
       "region_datasets": {
         "national": {
           "path_template": "enhanced_frs_2024_25.h5"
@@ -112,7 +112,7 @@
     },
     "us": {
       "build_id": "populace-us-2024-spm-20260915",
-      "bundle_id": "us-6.2.3",
+      "bundle_id": "us-6.2.5",
       "certification": {
         "built_with_model_version": "2.2.1",
         "certified_by": "policyengine.py bundle certification",
@@ -217,7 +217,7 @@
         "version": "2.2.1",
         "wheel_url": "https://files.pythonhosted.org/packages/5e/09/86ac3968d2a18e28fce3ba1186fc21728e9f299b96a806d6f204f1e0aaed/policyengine_us-2.2.1-py3-none-any.whl"
       },
-      "policyengine_version": "6.2.3",
+      "policyengine_version": "6.2.5",
       "region_datasets": {
         "congressional_district": {
           "path_template": "populace_us_2024_acs_local.h5"
@@ -295,10 +295,10 @@
   "packages": {
     "policyengine": {
       "import_name": "policyengine",
-      "install_requirement": "policyengine==6.2.3",
+      "install_requirement": "policyengine==6.2.5",
       "name": "policyengine",
       "role": "bundle_carrier",
-      "version": "6.2.3"
+      "version": "6.2.5"
     },
     "policyengine-core": {
       "import_name": "policyengine_core",
@@ -334,6 +334,6 @@
       "wheel_url": "https://files.pythonhosted.org/packages/19/a0/c484f69a0ebf88a9b9fd0ac28176f8df66550f46714f1b0c5ec0b360824e/spm_calculator-1.0.0-py3-none-any.whl"
     }
   },
-  "policyengine_version": "6.2.3",
+  "policyengine_version": "6.2.5",
   "schema_version": 2
 }

{policyengine-6.2.3 → policyengine-6.2.5}/src/policyengine/data/bundle/uk.trace.tro.jsonld

@@ -18,18 +18,18 @@
         "schema:url": "https://policyengine.org"
       },
       "schema:dateCreated": "2026-08-18T14:20:32.100961Z",
-      "schema:description": "TRACE TRO for certified runtime bundle uk-6.2.3 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
+      "schema:description": "TRACE TRO for certified runtime bundle uk-6.2.5 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
       "schema:name": "policyengine uk certified bundle TRO",
       "trov:createdWith": {
         "@type": "schema:SoftwareApplication",
         "schema:name": "policyengine",
-        "schema:softwareVersion": "6.2.3"
+        "schema:softwareVersion": "6.2.5"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle uk-6.2.3.",
+          "rdfs:comment": "Certified arrangement for bundle uk-6.2.5.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -75,7 +75,7 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for uk",
             "trov:mimeType": "application/json",
-            "trov:sha256": "4f4d1c5802ff917e555ce9f5520150fa4e7e1584853782afc38c03818101c9c6"
+            "trov:sha256": "41db4dcd0a64e37901493ffb2235e159892b4e2cb45224d5f83b696dee9d56ea"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -102,7 +102,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "23c38fee2f5fe5e6dd89137ba46b18b0add70f1a906cccbd28025f13c9061f64"
+          "trov:sha256": "2014602b75a33b7be85717d3ee86056dea50d0b7d37f802b89b0372fb7a80546"
         }
       },
       "trov:hasPerformance": {

{policyengine-6.2.3 → policyengine-6.2.5}/src/policyengine/data/bundle/us.trace.tro.jsonld

@@ -17,18 +17,18 @@
         "schema:name": "PolicyEngine",
         "schema:url": "https://policyengine.org"
       },
-      "schema:description": "TRACE TRO for certified runtime bundle us-6.2.3 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
+      "schema:description": "TRACE TRO for certified runtime bundle us-6.2.5 covering the bundle manifest, the certified dataset artifact, the country model wheel, and the country data release manifest when it is available.",
       "schema:name": "policyengine us certified bundle TRO",
       "trov:createdWith": {
         "@type": "schema:SoftwareApplication",
         "schema:name": "policyengine",
-        "schema:softwareVersion": "6.2.3"
+        "schema:softwareVersion": "6.2.5"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle us-6.2.3.",
+          "rdfs:comment": "Certified arrangement for bundle us-6.2.5.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -74,7 +74,7 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for us",
             "trov:mimeType": "application/json",
-            "trov:sha256": "4f4d1c5802ff917e555ce9f5520150fa4e7e1584853782afc38c03818101c9c6"
+            "trov:sha256": "41db4dcd0a64e37901493ffb2235e159892b4e2cb45224d5f83b696dee9d56ea"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -101,7 +101,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "f601acd275cdd7a90632c491593474090dac2c4478f372fe65472e23352e1194"
+          "trov:sha256": "a6b92e608e8ae897ad3e3f3e2fbbf14eefb50b9a21a2e0fa458b8693c00710cf"
         }
       },
       "trov:hasPerformance": {

{policyengine-6.2.3 → policyengine-6.2.5}/src/policyengine/tax_benefit_models/common/model_version.py

@@ -443,6 +443,21 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
                     "stored inputs (it has no record of them); run it again"
                 )
 
+        if self.country_code == "uk":
+            from policyengine.tax_benefit_models.uk.datasets import (
+                _year_file_records_data_year,
+            )
+
+            # UK outputs saved before runs anchored on the observed data year
+            # (PolicyEngine/policyengine.py#556) took a projected year as
+            # observed and uprated the State Pension by CPI, so they are not
+            # reused. ``Simulation.ensure()`` runs such a simulation again.
+            if not _year_file_records_data_year(Path(filepath)):
+                raise ValueError(
+                    "Saved UK simulation predates anchoring on the observed "
+                    "data year (it records none); run it again"
+                )
+
         simulation.output_dataset = self._dataset_class(
             id=simulation.id,
             name=simulation.dataset.name,