policyengine 6.1.1__tar.gz → 6.2.0__tar.gz

{policyengine-6.1.1 → policyengine-6.2.0}/.gitignore

@@ -7,3 +7,4 @@ _build/
 .env
 **/.DS_Store
 build/
+.hypothesis/

{policyengine-6.1.1 → policyengine-6.2.0}/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [6.2.0] - 2026-09-29
+
+### Added
+
+- Documented the default headline poverty measure (UK: absolute poverty before housing costs) and the reasons for it.
+
+### Changed
+
+- Bump policyengine-uk to 2.102.3, which rebases the absolute poverty line to HBAI's FYE 2025 reference year (431.69 BHC / 373.89 AHC a week at FYE 2025, as DWP has reported it since March 2026), and certify the UK data release `policyengine-uk-data-1.56.16` (enhanced_frs_2024_25) for it on the publisher's compatibility claim. UK absolute poverty rates rise: in 2026-27 on the certified enhanced FRS, by about 4 points overall and about 7 points for children after housing costs. The bump also brings every policyengine-uk change since 2.90.2, including relative poverty measured on the median over individuals (policyengine-uk#1865).
+
+
+## [6.1.2] - 2026-09-27
+
+### Changed
+
+- US files written before the WIC take-up mapping are no longer reused, because they may have lost the draw or were calculated without it. `Simulation.load()` raises for a saved US output that has no record of renamed stored inputs (`Simulation.ensure()` calculates it again), `load_datasets` raises for such a year file, and `ensure_datasets` creates such year files again.
+
+### Fixed
+
+- Map the stored US WIC take-up draw `would_claim_wic` onto `takes_up_wic_if_eligible` when loading US data, so policyengine-us 2.x no longer gives WIC to every WIC-eligible person in data that stores the draw under its old name, such as the certified default. `Simulation.run()`, `managed_microsimulation` and `create_datasets` apply the mapping and record the renames applied (output dataset metadata, `release_bundle`, saved output and year files, run records and `policyengine_bundle`). A stored table that is not in the simulation's person order, or that stores the draw for only part of a year, is refused. The mapping turns itself off once the data stores `takes_up_wic_if_eligible` or the engine defines `would_claim_wic` again.
+
+
 ## [6.1.1] - 2026-09-22
 
 ### Fixed

{policyengine-6.1.1/src/policyengine.egg-info → policyengine-6.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 6.1.1
+Version: 6.2.0
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -687,11 +687,11 @@ Requires-Dist: networkx>=3.0; extra == "graph"
 Provides-Extra: models
 Requires-Dist: policyengine-core==3.32.5; extra == "models"
 Requires-Dist: policyengine-us==2.2.1; extra == "models"
-Requires-Dist: policyengine-uk==2.90.2; extra == "models"
+Requires-Dist: policyengine-uk==2.102.3; extra == "models"
 Requires-Dist: spm-calculator==1.0.0; extra == "models"
 Provides-Extra: uk
 Requires-Dist: policyengine-core==3.32.5; extra == "uk"
-Requires-Dist: policyengine-uk==2.90.2; extra == "uk"
+Requires-Dist: policyengine-uk==2.102.3; extra == "uk"
 Provides-Extra: us
 Requires-Dist: policyengine-core==3.32.5; extra == "us"
 Requires-Dist: policyengine-us==2.2.1; extra == "us"
@@ -710,9 +710,10 @@ Requires-Dist: ruff>=0.9.0; extra == "dev"
 Requires-Dist: towncrier>=24.8.0; extra == "dev"
 Requires-Dist: mypy>=1.11.0; extra == "dev"
 Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: hypothesis>=6.100.0; extra == "dev"
 Requires-Dist: policyengine-core==3.32.5; extra == "dev"
 Requires-Dist: policyengine-us==2.2.1; extra == "dev"
-Requires-Dist: policyengine-uk==2.90.2; extra == "dev"
+Requires-Dist: policyengine-uk==2.102.3; extra == "dev"
 Requires-Dist: spm-calculator==1.0.0; extra == "dev"
 Dynamic: license-file
 

{policyengine-6.1.1 → policyengine-6.2.0}/docs/microsim.md

@@ -324,6 +324,53 @@ mode. GCS dataset URIs are not supported.
 For managed simulations, `sim.policyengine_bundle` records the actual source
 package, repository type, revision, verified SHA-256, and local path.
 
+## Renamed inputs in stored data
+
+A country engine sets a stored column as an input only when it defines a
+variable of that name. When policyengine-us renames an input, data written
+before the rename keeps the old name, and the engine would skip it.
+`policyengine.tax_benefit_models.us.legacy_inputs.LEGACY_INPUT_RENAMES` lists
+each such rename; today it holds one entry, `would_claim_wic` →
+`takes_up_wic_if_eligible` (the WIC take-up draw, PolicyEngine/microcosm#1026).
+
+Every US load path applies it: `Simulation.run()`, `managed_microsimulation`
+and `create_datasets` (and so `ensure_datasets` when it creates year files).
+A rename applies when the data stores the old name, the engine does not define
+the old name but does define the new one, and the data does not already store
+the new name. The new input is then set from the stored values for every month
+of every dataset year. The stored table must list the simulation's entity IDs
+in the simulation's order, or loading fails rather than attach values to the
+wrong people. Only values stored for a whole year are mapped, so a file that
+stores the old name for part of a year, and not the new name, is refused. The
+mapping turns itself off once the data stores the new name, or if the engine
+defines the old name again.
+
+The renames applied are recorded as `{old: new}` (`{}` when none applied):
+
+- `Simulation.run()`: `simulation.output_dataset.metadata["legacy_input_renames"]`,
+  also shown as `simulation.release_bundle["legacy_input_renames"]`. It
+  includes renames applied when the input year file was cut, so a run over a
+  `create_datasets` year file records the rename even though the file already
+  stores the new name. A US `save()` writes the record into the output file,
+  `load()` restores it, and a run record's `results.json` binds it;
+- `managed_microsimulation`: `sim.policyengine_bundle["legacy_input_renames"]`;
+- `create_datasets`: each year file, and each returned dataset's
+  `metadata["legacy_input_renames"]`.
+
+`{}` means that no stored column was mapped. It does not show that the data
+carried the draw: data that stores neither name runs with the new input's
+default, which for WIC is full take-up.
+
+Files written before this mapping existed have no record, and are not reused:
+
+- A saved US output may have been calculated without the mapped inputs.
+  `load()` refuses it, and `ensure()` runs the simulation again and saves the new
+  output.
+- A year file that `ensure_datasets` or `create_datasets` wrote stores
+  neither name, so the draw is lost from it. `ensure_datasets` creates such
+  year files again, and `load_datasets` refuses them. A year file opened
+  directly, as `PolicyEngineUSDataset(filepath=...)`, is not checked.
+
 ## Pinned model versions
 
 Every `policyengine` release pins specific country-model and country-data versions so results are reproducible. `pe.us.model` and `pe.uk.model` expose the pinned `TaxBenefitModelVersion`.

{policyengine-6.1.1 → policyengine-6.2.0}/docs/outputs.md

@@ -179,6 +179,18 @@ rates.dataframe
 
 Call it once per simulation for a baseline-vs-reform comparison. Age / gender / race breakdowns: `calculate_us_poverty_by_age`, `_by_gender`, `_by_race`. UK counterparts: `calculate_uk_poverty_rates`, `_by_age`, `_by_gender`.
 
+### Which measure to headline
+
+PolicyEngine headlines **absolute poverty before housing costs** in the UK: `absolute_bhc` in `calculate_uk_poverty_rates`, from the `in_poverty_bhc` variable. That function also returns `absolute_ahc`, `relative_bhc` and `relative_ahc`. In the US, `calculate_us_poverty_rates` returns the Supplemental Poverty Measure (`spm`) and deep SPM poverty (`spm_deep`).
+
+The reasons:
+
+- **Relative poverty measures inequality, not poverty.** policyengine-uk draws the relative line at 60% of each simulation's own median income. A reform that raises the median raises the line with it, so relative poverty can rise when every household is better off.
+  - Example: raising the personal allowance to £15,000 in 2026-27 lowers absolute child poverty and raises relative child poverty.
+- **After-housing-costs measures subtract housing spending,** and much of that spending is a choice: a flat or a mansion. International poverty statistics are computed on income before housing costs.
+
+The absolute line is HBAI's: 60% of median income in a fixed reference year, held constant in real terms (the `household.poverty.absolute_poverty_threshold_bhc` and `_ahc` parameters). Since the March 2026 HBAI release, DWP's reference year is FYE 2025 for FYE 2022 onward: 60% of the FYE 2025 medians of £719.48 (BHC) and £623.14 (AHC), so £431.69 and £373.89 a week (HBAI table 2.4ts). Earlier years keep the FYE 2011 reference, and DWP plans to extend FYE 2025 back to FYE 2019 in its March 2027 release. policyengine-uk follows the same split from version 2.102.3: FYE 2022 to FYE 2024 use HBAI's own annual CPI-variant deflators, and later years are uprated by the OBR's CPI forecast. Earlier policyengine-uk versions use the FYE 2011 line throughout, so their absolute rates are lower than DWP's.
+
 ## Inequality
 
 Gini, top-10 share, top-1 share, bottom-50 share — for one simulation.

{policyengine-6.1.1 → policyengine-6.2.0}/docs/run-records.md

@@ -46,7 +46,7 @@ The directory contains:
 | `bundle.trace.tro.jsonld` | The certified bundle TRO (model + data pins) |
 | `reform.json` | The reform as parameter values with effective dates |
 | `input.json` | Input dataset hash, dynamics, scoping, extra variables |
-| `results.json` | Output dataset hash and per-entity table summaries |
+| `results.json` | Output dataset hash and per-entity table summaries; for US runs, the SPM receipt and the renamed stored inputs mapped onto live ones (see [Renamed inputs in stored data](microsim.md#renamed-inputs-in-stored-data)) |
 
 All payload files are written with the same canonical JSON used for
 hashing, so the record verifies offline exactly as written.

{policyengine-6.1.1 → policyengine-6.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "policyengine"
-version = "6.1.1"
+version = "6.2.0"
 description = "A package to conduct policy analysis using PolicyEngine tax-benefit models."
 readme = "README.md"
 authors = [
@@ -42,12 +42,12 @@ graph = [
 models = [
     "policyengine-core==3.32.5",
     "policyengine-us==2.2.1",
-    "policyengine-uk==2.90.2",
+    "policyengine-uk==2.102.3",
     "spm-calculator==1.0.0",
 ]
 uk = [
     "policyengine-core==3.32.5",
-    "policyengine-uk==2.90.2",
+    "policyengine-uk==2.102.3",
 ]
 us = [
     "policyengine-core==3.32.5",
@@ -68,9 +68,10 @@ dev = [
     "towncrier>=24.8.0",
     "mypy>=1.11.0",
     "pytest-cov>=5.0.0",
+    "hypothesis>=6.100.0",
     "policyengine-core==3.32.5",
     "policyengine-us==2.2.1",
-    "policyengine-uk==2.90.2",
+    "policyengine-uk==2.102.3",
     "spm-calculator==1.0.0",
 ]
 

{policyengine-6.1.1 → policyengine-6.2.0}/src/policyengine/core/run_record.py

@@ -184,6 +184,15 @@ def build_simulation_run_record_payloads(
         input_payload["spm"] = simulation.spm_config
         results_payload["spm"] = simulation.spm_provenance()
 
+    # Stored inputs the country loader mapped onto renamed live inputs (for
+    # example the US WIC take-up draw) change the results, so the record
+    # binds them. See ``policyengine.tax_benefit_models.us.legacy_inputs``.
+    renames = (getattr(simulation.output_dataset, "metadata", None) or {}).get(
+        "legacy_input_renames"
+    )
+    if renames is not None:
+        results_payload["legacy_input_renames"] = dict(renames)
+
     return {"reform": reform, "input": input_payload, "results": results_payload}
 
 

{policyengine-6.1.1 → policyengine-6.2.0}/src/policyengine/core/simulation.py

@@ -240,7 +240,7 @@ class Simulation(BaseModel):
             if self.tax_benefit_model_version is not None
             else {}
         )
-        result = {
+        result: dict[str, Any] = {
             **bundle,
             "dataset_filepath": self.dataset.filepath
             if self.dataset is not None
@@ -250,4 +250,12 @@ class Simulation(BaseModel):
             recorded = getattr(self.output_dataset, "metadata", {}).get("spm_config")
             result["spm_config"] = dict(recorded or self.spm_config)
             result["spm"] = self.spm_provenance()
+        # Stored inputs the country loader mapped onto renamed live inputs
+        # (for example the US WIC take-up draw), as the run recorded them.
+        # See ``policyengine.tax_benefit_models.us.legacy_inputs``.
+        renames = (getattr(self.output_dataset, "metadata", None) or {}).get(
+            "legacy_input_renames"
+        )
+        if renames is not None:
+            result["legacy_input_renames"] = dict(renames)
         return result

{policyengine-6.1.1 → policyengine-6.2.0}/src/policyengine/data/bundle/manifest.json

@@ -1,10 +1,10 @@
 {
-  "bundle_version": "6.1.1",
+  "bundle_version": "6.2.0",
   "citation": {
     "publisher": "PolicyEngine",
-    "title": "PolicyEngine bundle 6.1.1",
+    "title": "PolicyEngine bundle 6.2.0",
     "type": "software-bundle",
-    "version": "6.1.1"
+    "version": "6.2.0"
   },
   "countries": {
     "uk": {
@@ -17,12 +17,12 @@
   "data_releases": {
     "uk": {
       "build_id": "policyengine-uk-data-1.56.16",
-      "bundle_id": "uk-6.1.1",
+      "bundle_id": "uk-6.2.0",
       "certification": {
         "built_with_model_git_sha": "12a1e028afeef08d8b2d74ee03fd9de3a78b2dd3",
         "built_with_model_version": "2.89.2",
         "certified_by": "policyengine.py bundle certification",
-        "certified_for_model_version": "2.90.2",
+        "certified_for_model_version": "2.102.3",
         "compatibility_basis": "legacy_compatible_model_package",
         "data_build_fingerprint": "sha256:6bfff835b504094c05342d2b4d770d2d94c8c1adcb15c4468931f53b21a89ea9",
         "data_build_id": "policyengine-uk-data-1.56.16"
@@ -41,7 +41,7 @@
       "data_package": {
         "name": "policyengine-uk-data",
         "release_manifest_path": "releases/1.56.16/release_manifest.json",
-        "release_manifest_revision": "2966541fca275ab5ccb6cfb659b010b1db37ad49",
+        "release_manifest_revision": "78788372fec47fc8df835bd32307ef61eaed83c2",
         "repo_id": "policyengine/policyengine-uk-data-private",
         "repo_type": "model",
         "version": "1.56.16"
@@ -95,24 +95,24 @@
       "default_dataset_uri": "hf://policyengine/policyengine-uk-data-private/enhanced_frs_2024_25.h5@1.56.16",
       "model_package": {
         "name": "policyengine-uk",
-        "sha256": "f100ef97e20b29b84138078f1dbc5b83f8857e6bc74b745fc6abef7ea1eeadf2",
-        "version": "2.90.2",
-        "wheel_url": "https://files.pythonhosted.org/packages/ec/da/658bff2df6094bd7bf2b0f561ff60fd41508adbd0a3af29b4553c83bc678/policyengine_uk-2.90.2-py3-none-any.whl"
+        "sha256": "f02a76712a3edf9983c713c1db42e9653a6e974e4ce335dd4b5676bbc2bcd636",
+        "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.1.1",
+      "policyengine_version": "6.2.0",
       "region_datasets": {
         "national": {
           "path_template": "enhanced_frs_2024_25.h5"
         }
       },
-      "release_manifest_uri": "https://huggingface.co/policyengine/policyengine-uk-data-private/resolve/2966541fca275ab5ccb6cfb659b010b1db37ad49/releases/1.56.16/release_manifest.json",
+      "release_manifest_uri": "https://huggingface.co/policyengine/policyengine-uk-data-private/resolve/78788372fec47fc8df835bd32307ef61eaed83c2/releases/1.56.16/release_manifest.json",
       "schema_version": 1,
-      "source_manifest_uri": "hf://model/policyengine/policyengine-uk-data-private@2966541fca275ab5ccb6cfb659b010b1db37ad49/releases/1.56.16/release_manifest.json",
+      "source_manifest_uri": "hf://model/policyengine/policyengine-uk-data-private@78788372fec47fc8df835bd32307ef61eaed83c2/releases/1.56.16/release_manifest.json",
       "version": "policyengine-uk-data-1.56.16"
     },
     "us": {
       "build_id": "populace-us-2024-spm-20260915",
-      "bundle_id": "us-6.1.1",
+      "bundle_id": "us-6.2.0",
       "certification": {
         "built_with_model_version": "2.2.1",
         "certified_by": "policyengine.py bundle certification",
@@ -210,7 +210,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.1.1",
+      "policyengine_version": "6.2.0",
       "region_datasets": {
         "national": {
           "path_template": "populace_us_2024.h5"
@@ -290,10 +290,10 @@
   "packages": {
     "policyengine": {
       "import_name": "policyengine",
-      "install_requirement": "policyengine==6.1.1",
+      "install_requirement": "policyengine==6.2.0",
       "name": "policyengine",
       "role": "bundle_carrier",
-      "version": "6.1.1"
+      "version": "6.2.0"
     },
     "policyengine-core": {
       "import_name": "policyengine_core",
@@ -305,10 +305,10 @@
     "policyengine-uk": {
       "country": "uk",
       "import_name": "policyengine_uk",
-      "install_requirement": "policyengine-uk==2.90.2",
+      "install_requirement": "policyengine-uk==2.102.3",
       "name": "policyengine-uk",
       "role": "country_model",
-      "version": "2.90.2"
+      "version": "2.102.3"
     },
     "policyengine-us": {
       "country": "us",
@@ -329,6 +329,6 @@
       "wheel_url": "https://files.pythonhosted.org/packages/19/a0/c484f69a0ebf88a9b9fd0ac28176f8df66550f46714f1b0c5ec0b360824e/spm_calculator-1.0.0-py3-none-any.whl"
     }
   },
-  "policyengine_version": "6.1.1",
+  "policyengine_version": "6.2.0",
   "schema_version": 2
 }

{policyengine-6.1.1 → policyengine-6.2.0}/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.1.1 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.0 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.1.1"
+        "schema:softwareVersion": "6.2.0"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle uk-6.1.1.",
+          "rdfs:comment": "Certified arrangement for bundle uk-6.2.0.",
           "trov:hasArtifactLocation": [
             {
               "@id": "arrangement/1/location/bundle_manifest",
@@ -45,7 +45,7 @@
               "trov:hasArtifact": {
                 "@id": "composition/1/artifact/data_release_manifest"
               },
-              "trov:hasLocation": "https://huggingface.co/policyengine/policyengine-uk-data-private/resolve/2966541fca275ab5ccb6cfb659b010b1db37ad49/releases/1.56.16/release_manifest.json"
+              "trov:hasLocation": "https://huggingface.co/policyengine/policyengine-uk-data-private/resolve/78788372fec47fc8df835bd32307ef61eaed83c2/releases/1.56.16/release_manifest.json"
             },
             {
               "@id": "arrangement/1/location/dataset",
@@ -61,7 +61,7 @@
               "trov:hasArtifact": {
                 "@id": "composition/1/artifact/model_wheel"
               },
-              "trov:hasLocation": "https://files.pythonhosted.org/packages/ec/da/658bff2df6094bd7bf2b0f561ff60fd41508adbd0a3af29b4553c83bc678/policyengine_uk-2.90.2-py3-none-any.whl"
+              "trov:hasLocation": "https://files.pythonhosted.org/packages/37/e6/e8d9069d498f1510a1380f24a78e957902d01f00b10248c146d6710d5b37/policyengine_uk-2.102.3-py3-none-any.whl"
             }
           ]
         }
@@ -75,14 +75,14 @@
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine.py bundle manifest for uk",
             "trov:mimeType": "application/json",
-            "trov:sha256": "9a76d034b5a0ce197deb0c54bd2db9462ea83edb175a8460ce0ed7c4241794de"
+            "trov:sha256": "8a942b26fec7ed828ba533c6c456d95c3292c52a0370e1713a4e2d6cf186ae29"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
             "@type": "trov:ResearchArtifact",
             "schema:name": "policyengine-uk-data release manifest 1.56.16",
             "trov:mimeType": "application/json",
-            "trov:sha256": "9bfccac472d74b044596205ee153b0c81fcd8d93e84f5820c7081e30f2cab0c5"
+            "trov:sha256": "cb61e3d897fbfa0cc079edc140aebc8947b1a685f581a420de91170ce2686155"
           },
           {
             "@id": "composition/1/artifact/dataset",
@@ -94,15 +94,15 @@
           {
             "@id": "composition/1/artifact/model_wheel",
             "@type": "trov:ResearchArtifact",
-            "schema:name": "policyengine-uk==2.90.2 wheel",
+            "schema:name": "policyengine-uk==2.102.3 wheel",
             "trov:mimeType": "application/zip",
-            "trov:sha256": "f100ef97e20b29b84138078f1dbc5b83f8857e6bc74b745fc6abef7ea1eeadf2"
+            "trov:sha256": "f02a76712a3edf9983c713c1db42e9653a6e974e4ce335dd4b5676bbc2bcd636"
           }
         ],
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "deba9f160ccccd67fac7d8075291565804a5892176390c7c2c1b745b9b36a162"
+          "trov:sha256": "aa8a6265cb0660dcbe3d1d8560cfea70011927ff2f29e8f91d4dad4efc9b055a"
         }
       },
       "trov:hasPerformance": {
@@ -111,12 +111,12 @@
         "pe:builtWithModelGitSha": "12a1e028afeef08d8b2d74ee03fd9de3a78b2dd3",
         "pe:builtWithModelVersion": "2.89.2",
         "pe:certifiedBy": "policyengine.py bundle certification",
-        "pe:certifiedForModelVersion": "2.90.2",
+        "pe:certifiedForModelVersion": "2.102.3",
         "pe:compatibilityBasis": "legacy_compatible_model_package",
         "pe:dataBuildFingerprint": "sha256:6bfff835b504094c05342d2b4d770d2d94c8c1adcb15c4468931f53b21a89ea9",
         "pe:dataBuildId": "policyengine-uk-data-1.56.16",
         "pe:emittedIn": "repository-bundle",
-        "rdfs:comment": "Certification of build policyengine-uk-data-1.56.16 for policyengine-uk 2.90.2.",
+        "rdfs:comment": "Certification of build policyengine-uk-data-1.56.16 for policyengine-uk 2.102.3.",
         "trov:accessedArrangement": {
           "@id": "arrangement/1"
         },

{policyengine-6.1.1 → policyengine-6.2.0}/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.1.1 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.0 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.1.1"
+        "schema:softwareVersion": "6.2.0"
       },
       "trov:hasArrangement": [
         {
           "@id": "arrangement/1",
           "@type": "trov:ArtifactArrangement",
-          "rdfs:comment": "Certified arrangement for bundle us-6.1.1.",
+          "rdfs:comment": "Certified arrangement for bundle us-6.2.0.",
           "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": "9a76d034b5a0ce197deb0c54bd2db9462ea83edb175a8460ce0ed7c4241794de"
+            "trov:sha256": "8a942b26fec7ed828ba533c6c456d95c3292c52a0370e1713a4e2d6cf186ae29"
           },
           {
             "@id": "composition/1/artifact/data_release_manifest",
@@ -101,7 +101,7 @@
         "trov:hasFingerprint": {
           "@id": "composition/1/fingerprint",
           "@type": "trov:CompositionFingerprint",
-          "trov:sha256": "d0d91d66dc9d99e9af859329a738a50b2c8778d121cc5157565081f99b5f8c0c"
+          "trov:sha256": "acb3c462fafa434aa3f54fd5cfed5e38647679da1889582c3c5edfded5e13dbb"
         }
       },
       "trov:hasPerformance": {

{policyengine-6.1.1 → policyengine-6.2.0}/src/policyengine/tax_benefit_models/common/model_version.py

@@ -358,6 +358,9 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
         serialized_spm = None
         if self.country_code == "us":
             from policyengine.core.spm import SPMProvenance
+            from policyengine.tax_benefit_models.us.legacy_inputs import (
+                RENAMES_RECORD_KEY,
+            )
 
             receipt = SPMProvenance.model_validate(simulation.spm_provenance())
             if (
@@ -374,6 +377,17 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
                 },
                 sort_keys=True,
             )
+            # ``PolicyEngineUSDataset.save()`` writes this record into the
+            # file, and ``load()`` refuses an output without it.
+            renames = (getattr(simulation.output_dataset, "metadata", None) or {}).get(
+                RENAMES_RECORD_KEY
+            )
+            if renames is None:
+                raise ValueError(
+                    "This US output does not record which renamed stored "
+                    "inputs were mapped when it was calculated; run again "
+                    "before saving"
+                )
         simulation.output_dataset.save()
         if serialized_spm is not None:
             # Store UTF-8 JSON in a dataset rather than an attribute: the
@@ -399,6 +413,10 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
         receipt = None
         if self.country_code == "us":
             from policyengine.core.spm import SPMProvenance
+            from policyengine.tax_benefit_models.us.legacy_inputs import (
+                RENAMES_RECORD_KEY,
+                read_renames_record,
+            )
 
             with h5py.File(filepath, "r") as stream:
                 raw = (
@@ -406,6 +424,7 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
                     if "policyengine_spm" in stream
                     else None
                 )
+            recorded_renames = read_renames_record(filepath)
             if raw is None:
                 raise ValueError(
                     "Saved US simulation has no SPM configuration or receipt"
@@ -414,6 +433,15 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
             if recorded["config"] != simulation.spm_config:
                 raise ValueError("Saved US simulation uses different SPM settings")
             receipt = SPMProvenance.model_validate(recorded["provenance"])
+            # Outputs saved before stored inputs were mapped onto renamed
+            # live inputs were calculated without them (for example with
+            # every WIC-eligible person taking WIC up), so they are not
+            # reused. ``Simulation.ensure()`` runs such a simulation again.
+            if recorded_renames is None:
+                raise ValueError(
+                    "Saved US simulation predates the mapping of renamed "
+                    "stored inputs (it has no record of them); run it again"
+                )
 
         simulation.output_dataset = self._dataset_class(
             id=simulation.id,
@@ -428,7 +456,9 @@ class MicrosimulationModelVersion(TaxBenefitModelVersion):
 
             simulation.spm_receipt = receipt
             simulation.spm = SPMSelection.model_validate(recorded["config"])
-            simulation.output_dataset.metadata["spm_config"] = recorded["config"]
+            simulation.output_dataset.metadata.update(
+                {"spm_config": recorded["config"], RENAMES_RECORD_KEY: recorded_renames}
+            )
 
         if os.path.exists(filepath):
             simulation.created_at = datetime.datetime.fromtimestamp(