policyengine-uk 2.53.1__py3-none-any.whl → 2.54.2__py3-none-any.whl

policyengine_uk/data/__init__.py

@@ -2,3 +2,4 @@ from policyengine_uk.data.dataset_schema import (
     UKMultiYearDataset,
     UKSingleYearDataset,
 )
+from .filter_dataset import filter_dataset

policyengine_uk/data/economic_assumptions.py

@@ -9,6 +9,7 @@ import logging
 
 def extend_single_year_dataset(
     dataset: UKSingleYearDataset,
+    tax_benefit_system_parameters: ParameterNode,
     end_year: int = 2030,
 ) -> UKMultiYearDataset:
     # Extend years and uprate
@@ -19,11 +20,15 @@ def extend_single_year_dataset(
         next_year.time_period = str(year)
         datasets.append(next_year)
     multi_year_dataset = UKMultiYearDataset(datasets=datasets)
-    return apply_uprating(multi_year_dataset)
+    return apply_uprating(
+        multi_year_dataset,
+        tax_benefit_system_parameters=tax_benefit_system_parameters,
+    )
 
 
 def apply_uprating(
     dataset: UKMultiYearDataset,
+    tax_benefit_system_parameters: ParameterNode = None,
 ):
     from policyengine_uk.system import system
 
@@ -38,7 +43,9 @@ def apply_uprating(
             continue  # Don't uprate the first year
         current_year = dataset.datasets[year]
         prev_year = dataset.datasets[year - 1]
-        apply_single_year_uprating(current_year, prev_year, system.parameters)
+        apply_single_year_uprating(
+            current_year, prev_year, tax_benefit_system_parameters
+        )
 
     return dataset
 

policyengine_uk/data/filter_dataset.py

@@ -0,0 +1,52 @@
+import typing
+
+if typing.TYPE_CHECKING:
+    from policyengine_uk import Microsimulation
+    from policyengine_uk.data import UKSingleYearDataset
+
+
+def filter_dataset(
+    sim: "Microsimulation", household_id: int, year: int = 2026
+) -> "UKSingleYearDataset":
+    from policyengine_uk import Microsimulation
+    from policyengine_uk.data import UKSingleYearDataset
+
+    """
+    Extract a single household from a simulation dataset.
+
+    This function creates a new dataset containing only the specified household
+    and the associated benefit units and people within that household.
+
+    Parameters
+    ----------
+    sim : Microsimulation
+        The microsimulation object containing the dataset.
+    household_id : int
+        The ID of the household to extract.
+    year : int, default 2026
+        The dataset year to filter.
+
+    Returns
+    -------
+    UKSingleYearDataset
+        A new dataset containing only data for the specified household.
+    """
+    dataset: UKSingleYearDataset = sim.dataset[year]
+    new_dataset = dataset.copy()
+    new_dataset.person = new_dataset.person[
+        new_dataset.person.person_household_id == household_id
+    ]
+    new_dataset.household = new_dataset.household[
+        new_dataset.household.household_id == household_id
+    ]
+    benunits = new_dataset.person.person_benunit_id.unique()
+    new_dataset.benunit = new_dataset.benunit[
+        new_dataset.benunit.benunit_id.isin(benunits)
+    ]
+
+    return UKSingleYearDataset(
+        person=new_dataset.person,
+        household=new_dataset.household,
+        benunit=new_dataset.benunit,
+        fiscal_year=year,
+    )

policyengine_uk/dynamics/labour_supply.py

@@ -28,7 +28,7 @@ from .participation import (
 
 
 def calculate_excluded_from_labour_supply_responses(
-    sim: Simulation, count_adults: int = 1
+    sim: Simulation, count_adults: int = 2
 ):
     """Calculate which individuals are excluded from labour supply responses.
 
@@ -97,10 +97,10 @@ class LabourSupplyResponseData(BaseModel):
 
 def apply_labour_supply_responses(
     sim: Simulation,
-    target_variable: str = "household_net_income",
+    target_variable: str = "hbai_household_net_income",
     input_variable: str = "employment_income",
     year: int = 2025,
-    count_adults: int = 1,
+    count_adults: int = 2,
     delta: float = 1_000,
 ) -> pd.DataFrame:
     """Apply labour supply responses to simulation and return the response vector.
@@ -197,10 +197,10 @@ def apply_labour_supply_responses(
 
 def apply_progression_responses(
     sim: Simulation,
-    target_variable: str = "household_net_income",
+    target_variable: str = "hbai_household_net_income",
     input_variable: str = "employment_income",
     year: int = 2025,
-    count_adults: int = 1,
+    count_adults: int = 2,
     delta: float = 1_000,
     pre_calculated_income_rel_change: np.ndarray = None,
 ) -> pd.DataFrame:
@@ -233,6 +233,7 @@ def apply_progression_responses(
     derivative_changes = derivative_changes.rename(
         columns={col: f"deriv_{col}" for col in derivative_changes.columns}
     )
+    derivative_changes["person_id"] = sim.calculate("person_id", year).values
 
     # Add in actual implied wages
     gross_wage = sim.calculate("employment_income", year) / sim.calculate(
@@ -262,20 +263,13 @@ def apply_progression_responses(
 
     # Calculate changes in income levels (drives income effects)
     if pre_calculated_income_rel_change is not None:
-        # Use pre-calculated values
         n_people = len(sim.calculate("person_id", year))
         income_changes = pd.DataFrame(
             {
-                "baseline": np.zeros(
-                    n_people
-                ),  # Not needed for behavioral response
-                "scenario": np.zeros(
-                    n_people
-                ),  # Not needed for behavioral response
+                "baseline": np.zeros(n_people),
+                "scenario": np.zeros(n_people),
                 "rel_change": pre_calculated_income_rel_change,
-                "abs_change": np.zeros(
-                    n_people
-                ),  # Not needed for behavioral response
+                "abs_change": np.zeros(n_people),
             }
         )
     else:

policyengine_uk/dynamics/progression.py

@@ -14,7 +14,7 @@ from policyengine_uk import Simulation
 
 def calculate_derivative(
     sim: Simulation,
-    target_variable: str = "household_net_income",
+    target_variable: str = "hbai_household_net_income",
     input_variable: str = "employment_income",
     year: int = 2025,
     count_adults: int = 2,
@@ -72,12 +72,12 @@ def calculate_derivative(
     sim.set_input(input_variable, year, input_variable_values)
 
     # Clip to ensure rates are between 0 and 1 (0% to 100% retention)
-    return rel_marginal_wages.clip(0, 1)
+    return rel_marginal_wages.round(4)
 
 
 def calculate_relative_income_change(
     sim: Simulation,
-    target_variable: str = "household_net_income",
+    target_variable: str = "hbai_household_net_income",
     year: int = 2025,
 ) -> pd.DataFrame:
     """Calculate relative change in income between baseline and scenario.
@@ -125,10 +125,10 @@ def calculate_relative_income_change(
 
 def calculate_derivative_change(
     sim: Simulation,
-    target_variable: str = "household_net_income",
+    target_variable: str = "hbai_household_net_income",
     input_variable: str = "employment_income",
     year: int = 2025,
-    count_adults: int = 1,
+    count_adults: int = 2,
     delta: float = 1_000,
 ) -> pd.DataFrame:
     """Calculate change in marginal rates between baseline and scenario.

policyengine_uk/scenarios/uc_reform.py

@@ -8,7 +8,9 @@ def add_universal_credit_reform(sim: Microsimulation):
         sim.tax_benefit_system.parameters.gov.dwp.universal_credit.rebalancing
     )
 
-    uc_seed = np.random.random(len(sim.calculate("benunit_id")))
+    generator = np.random.default_rng(43)
+
+    uc_seed = generator.random(len(sim.calculate("benunit_id")))
     p_uc_post_2026_status = {
         2025: 0,
         2026: 0.11,

policyengine_uk/simulation.py

@@ -84,6 +84,12 @@ class Simulation(CoreSimulation):
 
         self.branches: Dict[str, Simulation] = {}
 
+        if scenario is not None:
+            if scenario.parameter_changes is not None:
+                self.apply_parameter_changes(scenario.parameter_changes)
+            if scenario.simulation_modifier is not None:
+                scenario.simulation_modifier(self)
+
         # Build simulation from appropriate source
         if situation is not None:
             self.build_from_situation(situation)
@@ -104,8 +110,6 @@ class Simulation(CoreSimulation):
         else:
             raise ValueError(f"Unsupported dataset type: {dataset.__class__}")
 
-        self.input_variables = self.get_known_variables()
-
         # Universal Credit reform (July 2025). Needs closer integration in the baseline,
         # but adding here for ease of toggling on/off via the 'active' parameter.
         from policyengine_uk.scenarios import universal_credit_july_2025_reform
@@ -119,6 +123,8 @@ class Simulation(CoreSimulation):
         self.move_values("capital_gains", "capital_gains_before_response")
         self.move_values("employment_income", "employment_income_before_lsr")
 
+        self.input_variables = self.get_known_variables()
+
         if scenario is not None:
             self.baseline = Simulation(
                 scenario=None,
@@ -129,12 +135,6 @@ class Simulation(CoreSimulation):
         else:
             self.baseline = self.clone()
 
-        if scenario is not None:
-            if scenario.parameter_changes is not None:
-                self.apply_parameter_changes(scenario.parameter_changes)
-            if scenario.simulation_modifier is not None:
-                scenario.simulation_modifier(self)
-
         self.calculated_periods = []
 
     def reset_calculations(self):
@@ -321,7 +321,9 @@ class Simulation(CoreSimulation):
         dataset = UKSingleYearDataset.from_simulation(
             self, fiscal_year=first_time_period
         )
-        multi_year_dataset = extend_single_year_dataset(dataset)
+        multi_year_dataset = extend_single_year_dataset(
+            dataset, self.tax_benefit_system.parameters
+        )
 
         self.build_from_multi_year_dataset(multi_year_dataset)
         self.dataset = multi_year_dataset
@@ -335,7 +337,9 @@ class Simulation(CoreSimulation):
             dataset: UKSingleYearDataset containing one year of data
         """
 
-        dataset = extend_single_year_dataset(dataset)
+        dataset = extend_single_year_dataset(
+            dataset, self.tax_benefit_system.parameters
+        )
         self.build_from_multi_year_dataset(dataset)
         self.dataset = dataset
 

policyengine_uk/tests/microsimulation/reforms_config.yaml

@@ -1,10 +1,10 @@
 reforms:
 - name: Raise basic rate by 1pp
-  expected_impact: 8.0
+  expected_impact: 8.1
   parameters:
     gov.hmrc.income_tax.rates.uk[0].rate: 0.21
 - name: Raise higher rate by 1pp
-  expected_impact: 5.0
+  expected_impact: 4.9
   parameters:
     gov.hmrc.income_tax.rates.uk[1].rate: 0.42
 - name: Raise personal allowance by ~800GBP/year
@@ -12,22 +12,22 @@ reforms:
   parameters:
     gov.hmrc.income_tax.allowances.personal_allowance.amount: 13000
 - name: Raise child benefit by 25GBP/week per additional child
-  expected_impact: -1.5
+  expected_impact: -1.3
   parameters:
     gov.hmrc.child_benefit.amount.additional: 25
 - name: Reduce Universal Credit taper rate to 20%
-  expected_impact: -36.5
+  expected_impact: -36.0
   parameters:
     gov.dwp.universal_credit.means_test.reduction_rate: 0.2
 - name: Raise Class 1 main employee NICs rate to 10%
-  expected_impact: 12.4
+  expected_impact: 12.5
   parameters:
     gov.hmrc.national_insurance.class_1.rates.employee.main: 0.1
 - name: Raise VAT standard rate by 2pp
-  expected_impact: 21.2
+  expected_impact: 19.1
   parameters:
     gov.hmrc.vat.standard_rate: 0.22
 - name: Raise additional rate by 3pp
-  expected_impact: 5.4
+  expected_impact: 4.5
   parameters:
     gov.hmrc.income_tax.rates.uk[2].rate: 0.48

policyengine_uk/variables/household/post_tax_income.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+
+
+class post_tax_income(Variable):
+    label = "post-tax income"
+    documentation = "The income of a household after taxes have been deducted."
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    adds = ["total_income"]
+    subtracts = ["income_tax", "national_insurance"]

{policyengine_uk-2.53.1.dist-info → policyengine_uk-2.54.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine-uk
-Version: 2.53.1
+Version: 2.54.2
 Summary: PolicyEngine tax and benefit system for the UK.
 Project-URL: Homepage, https://github.com/PolicyEngine/policyengine-uk
 Project-URL: Repository, https://github.com/PolicyEngine/policyengine-uk

{policyengine_uk-2.53.1.dist-info → policyengine_uk-2.54.2.dist-info}/RECORD

@@ -3,16 +3,17 @@ policyengine_uk/entities.py,sha256=9yUbkUWQr3WydNE-gHhUudG97HGyXIZY3dkgQ6Z3t9A,1
 policyengine_uk/microsimulation.py,sha256=WskrrDrLGfDYwS1CzFk5rJkQSQlTknLkxFufStKRpxc,3379
 policyengine_uk/model_api.py,sha256=KdwJCL2HkXVxDpL6fCsCnQ9Sub6Kqp7Hyxlis3MNIx4,241
 policyengine_uk/modelled_policies.yaml,sha256=TLhvmkuI9ip-Fjq63n66RzDErCkN8K4BzY6XLxLMtFg,463
-policyengine_uk/simulation.py,sha256=n8LwAjabGHQLLg6bSWiotcJzrr49wDcvzaq1eOZSbqA,21265
+policyengine_uk/simulation.py,sha256=0FRttWoO05aTG7qvsJ5-mALEgxDHFCVRh28kwKP0XUY,21381
 policyengine_uk/system.py,sha256=Z-ax_ImUq5k4tycuThczTxQNW5iTE6ikBJIBQdKfIzU,91
 policyengine_uk/tax_benefit_system.py,sha256=CjX1lERyOm_vlgHQcQO92HZtJiwItLH-MxJveJqk6iM,5165
-policyengine_uk/data/__init__.py,sha256=J0bZ3WnvPzZ4qfVLYcwOc4lziMUMdbcMqJ3xwjoekbM,101
+policyengine_uk/data/__init__.py,sha256=fF3Qhm01PCx26pbG_WRKddacNzbgbuEoayV_xMETDgc,144
 policyengine_uk/data/dataset_schema.py,sha256=781beGVnPWJhw2FzcG6he-LtmgxtwS1h6keAz7TPoXI,10036
-policyengine_uk/data/economic_assumptions.py,sha256=U3wyBs4zVI5-bcMB-GivELC1qG-895l5NPds3cuWb90,6239
+policyengine_uk/data/economic_assumptions.py,sha256=rb4Utj5bHQhIXfz-eSLvluvyZXECvF_cWtag_sefr0s,6464
+policyengine_uk/data/filter_dataset.py,sha256=DtIixUMRnY-g-acXZIxaZ5217NYYVAMxVgs1Wa3rya0,1622
 policyengine_uk/data/uprating_indices.yaml,sha256=kQtfeGWyqge4dbJhs0iF4kTMqovuegill_Zfs8orJi4,2394
-policyengine_uk/dynamics/labour_supply.py,sha256=o2UIljuEx1tesZj5n_gzbBqvMzbF8Ko5_VVS5Ky6gP0,12250
+policyengine_uk/dynamics/labour_supply.py,sha256=MQnlp2OfD2RboqBOxKoLHzVKfZjP04j6Oif1Jswp1-w,12074
 policyengine_uk/dynamics/participation.py,sha256=g5xUqg-Nj2lQny9GrUfI2D_swLx0-9k-486NXtcWwbM,23238
-policyengine_uk/dynamics/progression.py,sha256=ViyOrpn4uOfYW43sCuBcLP8KiJ5hZyhblEV_BIEUtnQ,14067
+policyengine_uk/dynamics/progression.py,sha256=Mym2IxkcL20gKPZXk0JmT6quo0A9XU5_SbpShpa_PxE,14080
 policyengine_uk/parameters/gov/README.md,sha256=bHUep1_2pLHD3Or8SwjStOWXDIbW9OuYxOd4ml8IXcM,13
 policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml,sha256=2zOSdJeUhDZYYsKE2vLkcK-UbKNoOSVwfac0QIAp02g,250
 policyengine_uk/parameters/gov/contrib/README.md,sha256=b282dmUFAmj7cXSfiMLyE81q5Y0Gnehy-6atLus-ESs,70
@@ -539,13 +540,13 @@ policyengine_uk/scenarios/__init__.py,sha256=OP_05x7RS8qUuwEN6tqoTGwrpk8vYLxCSav
 policyengine_uk/scenarios/pip_reform.py,sha256=fv6-HCuRxhzt-XEYv9yLJTEliAWu3EGx6duADSBO4n8,687
 policyengine_uk/scenarios/reindex_benefit_cap.py,sha256=dPUOsTkgYZNRN15e_ax5hg5ObHngk5tizz7FYStkGaE,1070
 policyengine_uk/scenarios/repeal_two_child_limit.py,sha256=vZndQVFNCe7v7k4v-PgneOCPld-YTnCmlveRbX_1czk,250
-policyengine_uk/scenarios/uc_reform.py,sha256=WPYKGBY_V7A0pQPxDM0lOYTR9GoLrF-iEm_8aXg5fXU,1840
+policyengine_uk/scenarios/uc_reform.py,sha256=xfgNRVR5S_UMKmd3Zivrc717DvJX4hVqf2gTUlocGQA,1883
 policyengine_uk/tests/test_behavioral_responses.py,sha256=xuKOyuki6nLMrS-XArRqs8nU-o538eyMG2eAB1WDHHY,8191
 policyengine_uk/tests/test_parameter_metadata.py,sha256=_2w2dSokAf5Jskye_KIL8eh80N7yIrUszlmqnZtwQws,450
 policyengine_uk/tests/behavioral_responses/test_labor_supply_responses.yaml,sha256=xR8cy0XjcG8xTL_ufgEl1BHNWhXefVnA2va7X3v6FBk,5783
 policyengine_uk/tests/code_health/test_variables.py,sha256=9Y-KpmzhyRGy9eEqocK9z91NXHX5QIF3mDMNGvegb7Q,1398
 policyengine_uk/tests/microsimulation/README.md,sha256=1toB1Z06ynlUielTrsAaeo9Vb-c3ZrB3tbbR4E1xUGk,3924
-policyengine_uk/tests/microsimulation/reforms_config.yaml,sha256=M4A8PIdTfxGxGF7iSk8lKqriqR9HrV6VtyPGzS2BkrM,1086
+policyengine_uk/tests/microsimulation/reforms_config.yaml,sha256=-XQjsQfb3GGs-qwdAP7OVT_OG2g3zHyDbHcw82p5UX8,1086
 policyengine_uk/tests/microsimulation/test_reform_impacts.py,sha256=xM3M2pclEhA9JIFpnuiPMy1fEBFOKcSzroRPk73FPls,2635
 policyengine_uk/tests/microsimulation/test_validity.py,sha256=_mHgrNu-hKzVd9V2GSg_yPQgJctxRzdQM7lM2bUvqNY,636
 policyengine_uk/tests/microsimulation/update_reform_impacts.py,sha256=4m5EpPu4SXTE3qOPkx3eIZnlaOzprfm6GmMCXETZuLk,6890
@@ -1137,6 +1138,7 @@ policyengine_uk/variables/household/cliff_evaluated.py,sha256=UfQ3GYys2L61PyAMWr
 policyengine_uk/variables/household/cliff_gap.py,sha256=jZmKoLjJYAojwUEF4cfu4wvfaeN_tMYFhpRYdVk1_Vs,498
 policyengine_uk/variables/household/is_on_cliff.py,sha256=MmRHX9pxnzUKGgPw2F_5dSlLv8NjSQOvcH9Z4r6-MQM,392
 policyengine_uk/variables/household/marginal_tax_rate.py,sha256=hK41cSc9i4QAnGBLqUViwTiw3BsQPtfsO3jjvRfjhPE,2001
+policyengine_uk/variables/household/post_tax_income.py,sha256=YP4fL_hHdOK1LXQ9huqfPiCewfQWd0RKpwJgRRLKweY,356
 policyengine_uk/variables/household/region.py,sha256=swhjOMUg_crfDi4oEcJY7GoaiNQXfMsyDnJPAmMjp5U,456
 policyengine_uk/variables/household/benefits/employment_benefits.py,sha256=Q3vdJv6MOTv4pIQkyOYhrfyztKV7t6kEAqIYssUNZw8,262
 policyengine_uk/variables/household/consumption/additional_residential_property_purchased.py,sha256=lUd5VjLB2jysui8RuLEJCC4C4Yx0zDXlpybLUEUHuiU,742
@@ -1390,7 +1392,7 @@ policyengine_uk/variables/misc/spi_imputed.py,sha256=iPVlBF_TisM0rtKvO-3-PQ2UYCe
 policyengine_uk/variables/misc/uc_migrated.py,sha256=zFNcUJaO8gwmbL1iY9GKgUt3G6J9yrCraqBV_5dCvlM,306
 policyengine_uk/variables/misc/categories/lower_middle_or_higher.py,sha256=C54tHYz2DmOyvQYCC1bF8RJwRZinhAq_e3aYC-9F5fM,157
 policyengine_uk/variables/misc/categories/lower_or_higher.py,sha256=81NIbLLabRr9NwjpUZDuV8IV8_mqmp5NM-CZvt55TwE,129
-policyengine_uk-2.53.1.dist-info/METADATA,sha256=BM9ZVTfzvrBkhIgH46wifXufZNvNxUd7PBjRcVMmLn0,3995
-policyengine_uk-2.53.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-policyengine_uk-2.53.1.dist-info/licenses/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
-policyengine_uk-2.53.1.dist-info/RECORD,,
+policyengine_uk-2.54.2.dist-info/METADATA,sha256=fDm5iuKgOdR8MdztQR6bxpBeKupSVTzNqi0hUNlw0SA,3995
+policyengine_uk-2.54.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+policyengine_uk-2.54.2.dist-info/licenses/LICENSE,sha256=dql8h4yceoMhuzlcK0TT_i-NgTFNIZsgE47Q4t3dUYI,34520
+policyengine_uk-2.54.2.dist-info/RECORD,,