Merge branch 'main' into add-scottish-child-payment

vahid-ahmadi · web-flow · commit 3818eedd1e6d · 2026-01-13T11:48:28.000Z
diff --git a/.github/workflows/code_changes.yaml b/.github/workflows/code_changes.yaml
@@ -1,10 +1,10 @@
-# Workflow that runs on code changes to the master branch.
+# Workflow that runs on code changes to the main branch.
 
 name: Code changes
 on:
   push:
     branches:
-      - master
+      - main
 
     paths:
       - policyengine_uk/**
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -5,7 +5,7 @@ name: Deploy documentation
 on:
   push:
     # Runs on pushes targeting the default branch
-    branches: [master]
+    branches: [main]
 env:
   # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
   # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
diff --git a/.github/workflows/pr_code_changes.yaml b/.github/workflows/pr_code_changes.yaml
@@ -4,7 +4,7 @@ name: Code changes
 on:
   pull_request:
     branches:
-      - master
+      - main
 
     paths:
       - policyengine_uk/**
diff --git a/.github/workflows/pr_docs_changes.yaml b/.github/workflows/pr_docs_changes.yaml
@@ -4,7 +4,7 @@ name: Docs changes
 on:
   pull_request:
     branches:
-      - master
+      - main
 
     paths:
       - docs/**
diff --git a/.github/workflows/versioning.yaml b/.github/workflows/versioning.yaml
@@ -1,10 +1,10 @@
 # Workflow that runs on versioning metadata updates.
 
-name: Versioning updates 
+name: Versioning updates
 on:
   push:
     branches:
-      - master
+      - main
 
     paths:
       - changelog_entry.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.66.0] - 2026-01-12 16:12:34
+
+### Fixed
+
+- LHA freeze parameter.
+
 ## [2.65.9] - 2025-12-09 16:16:37
 
 ### Fixed
@@ -2487,6 +2493,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+[2.66.0]: https://github.com/PolicyEngine/openfisca-uk/compare/2.65.9...2.66.0
 [2.65.9]: https://github.com/PolicyEngine/openfisca-uk/compare/2.65.8...2.65.9
 [2.65.8]: https://github.com/PolicyEngine/openfisca-uk/compare/2.65.7...2.65.8
 [2.65.7]: https://github.com/PolicyEngine/openfisca-uk/compare/2.65.6...2.65.7
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 PolicyEngine UK is [PolicyEngine](https://policyengine.org)'s microsimulation model of the UK tax-benefit system.
-It uses the PolicyEngine Core microsimulation framework, which is based on [OpenFisca](https://openfisca.org).
+It uses the PolicyEngine Core microsimulation framework, which is based on [OpenFisca](https://openfisca.org). 
 
 The elements are described in different folders. All the modelling happens within the `policyengine_uk` folder.
 
diff --git a/changelog.yaml b/changelog.yaml
@@ -2138,3 +2138,8 @@
     - Refactor variables with redundant adds/subtracts and formula definitions to
       prevent sync issues
   date: 2025-12-09 16:16:37
+- bump: minor
+  changes:
+    fixed:
+    - LHA freeze parameter.
+  date: 2026-01-12 16:12:34
diff --git a/changelog_entry.yaml b/changelog_entry.yaml
@@ -1,4 +1,4 @@
 - bump: minor
   changes:
     added:
-      - Scottish Child Payment - a benefit provided by Social Security Scotland for eligible children under 16 in low-income families receiving qualifying benefits (UC, tax credits, etc.).
+      - Scottish Child Payment - a benefit provided by Social Security Scotland for eligible children under 16 in low-income families receiving qualifying benefits (UC, tax credits, etc.).
diff --git a/policyengine_uk/entities.py b/policyengine_uk/entities.py
@@ -3,7 +3,7 @@
 # This file defines the entities needed by our legislation.
 from policyengine_core.entities import build_entity
 
-Household = build_entity(
+Household = build_entity( 
     key="household",
     plural="households",
     label="Household",
diff --git a/policyengine_uk/parameters/gov/dwp/LHA/freeze.yaml b/policyengine_uk/parameters/gov/dwp/LHA/freeze.yaml
@@ -1,9 +1,12 @@
-description: While this parameter is true, LHA rates are frozen in cash terms.
+description: While this parameter is true, LHA rates are frozen in cash terms. When this parameter is set to false from being true the previous year, values are uplifted to the (default 30th) BRMA percentile.
 values:
   2015-01-01: false
   2020-01-01: true
-  2023-12-31: false
-  2024-01-01: true
+  2024-04-06: false
+  2025-04-06: true
 metadata:
   unit: bool
-  label: LHA freeze
+  label: LHA freeze
+  reference:
+    - title: April 2024 LHA reset to 30th percentile
+      href: https://www.gov.uk/government/news/local-housing-allowance-rates-to-be-uprated-to-the-30th-percentile-of-local-market-rents
diff --git a/policyengine_uk/variables/gov/dwp/LHA_category.py b/policyengine_uk/variables/gov/dwp/LHA_category.py
@@ -93,23 +93,49 @@ def time_shift_dataset(
 
 
 def find_freeze_start(freeze_parameter: Parameter, period: str) -> str:
-    """Finds the first instant in which the LHA freeze was applied. Returns none if this is impossible.
+    """Finds the start instant of the current freeze period containing the given period.
+
+    The function works backwards from the given period to find when the current freeze
+    started. It looks for the most recent transition from false->true (unfreeze->freeze).
 
     Args:
         freeze_parameter (Parameter): The LHA freeze parameter.
         period (str): The period to search up to.
 
     Returns:
-        str: The first instant in which the LHA freeze was applied.
+        str: The instant when the current freeze period started, or None if not frozen.
     """
-    freeze_start = None
-    for i in range(len(freeze_parameter.values_list)):
-        param = freeze_parameter.values_list[i]
-        if param.instant_str > str(period):
-            continue
-        if (
-            i < len(freeze_parameter.values_list) - 1
-            and not freeze_parameter.values_list[i + 1].value
-        ):
-            return param.instant_str
+    # Get all parameter values that are <= the requested period
+    values_list = freeze_parameter.values_list
+    relevant_values = [v for v in values_list if v.instant_str <= str(period)]
+
+    if not relevant_values:
+        return None
+
+    # Check if the period is currently frozen
+    # relevant_values is in reverse chronological order (newest first)
+    current_state = relevant_values[0].value
+
+    if not current_state:
+        # Not currently frozen
+        return None
+
+    # Work from most recent backwards to find when this freeze started
+    # List is in reverse chronological order: [newest...oldest]
+    # Example: [('2026', True), ('2025', True), ('2024', False), ('2023', True)]
+    # Find the earliest True in the current frozen period
+    for i in range(len(relevant_values)):
+        current_value = relevant_values[i]
+
+        if current_value.value:  # This is a freeze=True value
+            # Check if the chronologically earlier period (i+1) was unfrozen
+            if i == len(relevant_values) - 1:
+                # This is the oldest value and it's frozen - use it
+                return current_value.instant_str
+            elif not relevant_values[i + 1].value:
+                # The chronologically earlier value was False
+                # This is where the freeze period started
+                return current_value.instant_str
+            # Otherwise the earlier value was also True, so continue backwards
+
     return None
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project] 
 name = "policyengine-uk"
-version = "2.65.9"
+version = "2.66.0"
 description = "PolicyEngine tax and benefit system for the UK."
 readme = "README.md"
 authors = [
