policyengine-uk 2.45.4__py3-none-any.whl → 2.47.3__py3-none-any.whl

policyengine_uk/tests/microsimulation/update_reform_impacts.py

@@ -8,6 +8,18 @@ from pathlib import Path
 from policyengine_uk import Microsimulation
 import argparse
 from datetime import datetime
+from rich.console import Console
+from rich.table import Table
+from rich.progress import (
+    Progress,
+    SpinnerColumn,
+    TextColumn,
+    BarColumn,
+    TaskProgressColumn,
+)
+from rich.panel import Panel
+from rich import print as rprint
+import traceback
 
 baseline = Microsimulation()
 
@@ -40,57 +52,97 @@ def update_impacts(
         dry_run: If True, show changes without writing to file
         verbose: If True, show detailed output
     """
+    console = Console()
+
     # Load current configuration
     with open(config_path, "r") as f:
         config = yaml.safe_load(f)
 
     if verbose:
-        print(f"Loaded configuration from {config_path}")
-        print(f"Found {len(config['reforms'])} reforms to update\n")
+        console.print(
+            Panel.fit(
+                f"[bold cyan]Loaded configuration from {config_path}[/bold cyan]\n"
+                f"[green]Found {len(config['reforms'])} reforms to update[/green]",
+                title="Configuration loaded",
+            )
+        )
 
     # Track changes
     changes = []
 
-    # Update each reform's expected impact
-    for reform in config["reforms"]:
-        print(f"Processing reform: {reform['name']}") if verbose else None
-        old_impact = reform["expected_impact"]
-        new_impact = round(get_fiscal_impact(reform["parameters"]), 1)
-
-        if (
-            abs(old_impact - new_impact) > 0.01
-        ):  # Only record meaningful changes
-            changes.append(
-                {
-                    "name": reform["name"],
-                    "old": old_impact,
-                    "new": new_impact,
-                    "diff": new_impact - old_impact,
-                }
-            )
-
-        reform["expected_impact"] = new_impact
+    # Update each reform's expected impact with progress bar
+    with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        BarColumn(),
+        TaskProgressColumn(),
+        console=console,
+    ) as progress:
+        task = progress.add_task(
+            "[cyan]Processing reforms...", total=len(config["reforms"])
+        )
 
-        if verbose:
-            print(f"Reform: {reform['name']}")
-            print(f"  Old impact: {old_impact:.1f} billion")
-            print(f"  New impact: {new_impact:.1f} billion")
-            if abs(old_impact - new_impact) > 0.01:
-                print(f"  Change: {new_impact - old_impact:+.1f} billion")
-            print()
+        for reform in config["reforms"]:
+            progress.update(
+                task, description=f"[cyan]Processing: {reform['name'][:40]}..."
+            )
+            old_impact = reform["expected_impact"]
+            new_impact = round(get_fiscal_impact(reform["parameters"]), 1)
+
+            if (
+                abs(old_impact - new_impact) > 0.01
+            ):  # Only record meaningful changes
+                changes.append(
+                    {
+                        "name": reform["name"],
+                        "old": old_impact,
+                        "new": new_impact,
+                        "diff": new_impact - old_impact,
+                    }
+                )
+
+            reform["expected_impact"] = new_impact
+            progress.advance(task)
+
+    # Show detailed output if verbose
+    if verbose and changes:
+        console.print("\n[bold]Detailed changes:[/bold]")
+        for change in changes:
+            color = "red" if change["diff"] < 0 else "green"
+            console.print(
+                f"  [yellow]{change['name']}[/yellow]\n"
+                f"    Old impact: [dim]{change['old']:.1f} billion[/dim]\n"
+                f"    New impact: [bold]{change['new']:.1f} billion[/bold]\n"
+                f"    Change: [{color}]{change['diff']:+.1f} billion[/{color}]\n"
+            )
 
     # Show summary of changes
     if changes:
-        print("\nSummary of changes:")
-        print("-" * 70)
+        table = Table(
+            title="Summary of changes",
+            show_header=True,
+            header_style="bold magenta",
+        )
+        table.add_column("Reform", style="cyan", no_wrap=False)
+        table.add_column("Old impact (£bn)", justify="right")
+        table.add_column("New impact (£bn)", justify="right")
+        table.add_column("Change (£bn)", justify="right")
+
         for change in changes:
-            print(
-                f"{change['name']:<50} {change['old']:>6.1f} → {change['new']:>6.1f} ({change['diff']:+.1f})"
+            color = "red" if change["diff"] < 0 else "green"
+            table.add_row(
+                change["name"],
+                f"{change['old']:.1f}",
+                f"{change['new']:.1f}",
+                f"[{color}]{change['diff']:+.1f}[/{color}]",
             )
-        print("-" * 70)
-        print(f"Total changes: {len(changes)}")
+
+        console.print("\n", table)
+        console.print(
+            f"\n[bold cyan]Total changes: {len(changes)}[/bold cyan]"
+        )
     else:
-        print("\nNo significant changes detected.")
+        console.print("\n[green]✓ No significant changes detected.[/green]")
 
     # Write updated configuration
     if not dry_run:
@@ -109,13 +161,22 @@ def update_impacts(
         with open(config_path, "w") as f:
             yaml.dump(config, f, default_flow_style=False, sort_keys=False)
 
-        print(f"\nConfiguration updated successfully!")
-        print(f"Backup saved to: {backup_path}")
+        console.print(
+            Panel.fit(
+                f"[green]✓ Configuration updated successfully![/green]\n"
+                f"[dim]Backup saved to: {backup_path}[/dim]",
+                title="Success",
+                border_style="green",
+            )
+        )
     else:
-        print("\nDry run - no changes written to file.")
+        console.print(
+            "\n[yellow]⚠ Dry run - no changes written to file.[/yellow]"
+        )
 
 
 def main():
+    console = Console()
     parser = argparse.ArgumentParser(
         description="Update reform impact expectations with current model values"
     )
@@ -143,14 +204,17 @@ def main():
     args = parser.parse_args()
 
     if not args.config.exists():
-        print(f"Error: Configuration file '{args.config}' not found!")
+        console.print(
+            f"[bold red]Error:[/bold red] Configuration file '{args.config}' not found!"
+        )
         return 1
 
     try:
         update_impacts(args.config, dry_run=args.dry_run, verbose=args.verbose)
         return 0
     except Exception as e:
-        print(f"Error updating impacts: {e}")
+        console.print(f"[bold red]Error updating impacts:[/bold red] {e}")
+        console.print(traceback.format_exc())
         return 1
 
 

policyengine_uk/tests/policy/baseline/gov/dfe/extended_childcare_entitlement/extended_childcare_entitlement.yaml

@@ -1,6 +1,6 @@
 - name: Eligible for 30 hours - All conditions met
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 3
   input:
     people:
       child1:
@@ -14,7 +14,7 @@
 
 - name: Eligible for 15 hours - All first conditions met
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 2
   input:
     people:
       child1:
@@ -42,7 +42,7 @@
 
 - name: Eligible for mixed hours - Family with multiple children
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 4
   input:
     people:
       child1:
@@ -74,7 +74,7 @@
 
 - name: Eligible with one working parent and one disabled parent
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 6
   input:
     people:
       child1:
@@ -107,7 +107,7 @@
 
 - name: Child using fewer hours than maximum entitlement
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 2
   input:
     people:
       child1:
@@ -122,7 +122,7 @@
 
 - name: Child using fewer hours than maximum entitlement - multiple children
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 2
   input:
     people:
       child1:
@@ -140,7 +140,7 @@
 
 - name: Benefit unit maximum hours cap applied
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 5
   input:
     people:
       child1:
@@ -177,7 +177,7 @@
 
 - name: Benefit unit without maximum hours cap applied with 3 years old child
   period: 2025
-  absolute_error_margin: 1
+  absolute_error_margin: 2
   input:
     people:
       child1:

policyengine_uk/utils/__init__.py

@@ -0,0 +1 @@
+from .compare import compare_simulations

policyengine_uk/utils/compare.py

@@ -0,0 +1,28 @@
+import pandas as pd
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from policyengine_uk.simulation import Microsimulation
+
+
+def compare_simulations(
+    simulations: list["Microsimulation"],
+    names: list[str],
+    year: int,
+    variables: list[str],
+):
+    dfs = [
+        sim.calculate_dataframe(variables, year).rename(
+            columns=lambda x: f"{x}_{name}"
+        )
+        for sim, name in zip(simulations, names)
+    ]
+
+    df = pd.concat(dfs, axis=1).reset_index().rename(columns={"index": "id"})
+
+    # Sort columns by variable
+    columns = []
+    for var in variables:
+        columns.extend([col for col in df.columns if col.startswith(var)])
+
+    return df[columns]

policyengine_uk/utils/scenario.py

@@ -2,6 +2,7 @@ from pydantic import BaseModel
 from typing import Optional, Callable, Dict, Type, Union
 from policyengine_core.simulations import Simulation
 from policyengine_core.reforms import Reform
+from policyengine_core.periods import period, instant
 
 
 class Scenario(BaseModel):
@@ -111,8 +112,42 @@ class Scenario(BaseModel):
 
         elif isinstance(reform, dict):
             # Dictionary of parameter changes
-            return cls(
-                parameter_changes=reform,
+            # Make sure to capture YYYY-MM-DD.YYYY-MM-DD.
+
+            def modifier(sim: Simulation):
+                for parameter in reform:
+                    if isinstance(reform[parameter], dict):
+                        for period_str, value in reform[parameter].items():
+                            if "." in period_str:
+                                start = instant(period_str.split(".")[0])
+                                stop = instant(period_str.split(".")[1])
+                                period_ = None
+                            else:
+                                period_ = period(period_str)
+                            sim.tax_benefit_system.parameters.get_child(
+                                parameter
+                            ).update(
+                                start=start,
+                                stop=stop,
+                                period=period_,
+                                value=value,
+                            )
+                    else:
+                        start = instant("2023-01-01")
+                        stop = None
+                        period_ = None
+
+                        sim.tax_benefit_system.parameters.get_child(
+                            parameter
+                        ).update(
+                            start=start,
+                            stop=stop,
+                            period=period_,
+                            value=reform[parameter],
+                        )
+
+            return Scenario(
+                simulation_modifier=modifier,
             )
 
         elif isinstance(reform, tuple):

policyengine_uk/utils/solve_private_school_attendance_factor.py

@@ -1,4 +1,4 @@
-from policyengine import Simulation
+from policyengine_uk import Microsimulation
 from policyengine_core.reforms import Reform
 from tqdm import tqdm
 
@@ -19,11 +19,9 @@ for factor in tqdm([round(x * 0.01, 2) for x in range(70, 91)]):
     }
 
     # Run the reformed microsimulation
-    reformed = Simulation(
-        scope="macro",
-        baseline=reform,
-        country="uk",
-    ).baseline_simulation
+    reformed = Microsimulation(
+        reform=reform,
+    )
     reformed.baseline_simulation.get_holder(
         "attends_private_school"
     ).delete_arrays()

policyengine_uk/variables/gov/dwp/additional_state_pension.py

@@ -13,7 +13,7 @@ class additional_state_pension(Variable):
         if simulation.dataset is None:
             return 0
 
-        data_year = simulation.dataset.time_period
+        data_year = 2023
         reported = person("state_pension_reported", data_year) / WEEKS_IN_YEAR
         type = person("state_pension_type", data_year)
         maximum_basic_sp = parameters(

policyengine_uk/variables/gov/dwp/basic_state_pension.py

@@ -13,7 +13,7 @@ class basic_state_pension(Variable):
         if simulation.dataset is None:
             return 0
 
-        data_year = simulation.dataset.time_period
+        data_year = 2023
         reported = person("state_pension_reported", data_year) / WEEKS_IN_YEAR
         type = person("state_pension_type", period)
         maximum_basic_sp = parameters(

policyengine_uk/variables/gov/gov_tax.py

@@ -26,7 +26,6 @@ class gov_tax(Variable):
         "national_insurance",
         "LVT",
         "carbon_tax",
-        "vat_change",
         "capital_gains_tax",
         "private_school_vat",
         "corporate_incident_tax_revenue_change",

policyengine_uk/variables/household/demographic/benunit/benunit_count_adults.py

@@ -0,0 +1,11 @@
+from policyengine_uk.model_api import *
+
+
+class benunit_count_adults(Variable):
+    value_type = int
+    entity = BenUnit
+    label = "number of adults in the benefit unit"
+    definition_period = YEAR
+
+    def formula(benunit, period, parameters):
+        return add(benunit, period, ["is_adult"])

policyengine_uk/variables/input/consumption/property/council_tax.py

@@ -9,38 +9,3 @@ class council_tax(Variable):
     definition_period = YEAR
     unit = GBP
     quantity_type = FLOW
-
-    def formula(household, period, parameters):
-        if period.start.year < 2023:
-            # We don't have growth rates for council tax by nation before this.
-            return 0
-
-        if household.simulation.dataset is None:
-            return 0
-
-        data_year = household.simulation.dataset.time_period
-
-        original_ct = household("council_tax", data_year)
-
-        ct = parameters.gov.economic_assumptions.indices.obr.council_tax
-
-        def get_growth(country):
-            param = getattr(ct, country)
-            return param(period.start.year) / param(data_year)
-
-        country = household("country", period).decode_to_str()
-
-        return select(
-            [
-                country == "ENGLAND",
-                country == "WALES",
-                country == "SCOTLAND",
-                True,
-            ],
-            [
-                original_ct * get_growth("england"),
-                original_ct * get_growth("wales"),
-                original_ct * get_growth("scotland"),
-                original_ct,
-            ],
-        )

policyengine_uk/variables/input/rent.py

@@ -11,43 +11,3 @@ class rent(Variable):
     value_type = float
     unit = GBP
     quantity_type = FLOW
-
-    def formula(household, period, parameters):
-        if period.start.year < 2023:
-            # We don't have growth rates for rent before this.
-            return 0
-
-        if household.simulation.dataset is None:
-            return 0
-
-        data_year = household.simulation.dataset.time_period
-        original_rent = household("rent", data_year)
-        tenure_type = household("tenure_type", period).decode_to_str()
-
-        is_social_rent = (tenure_type == "RENT_FROM_COUNCIL") | (
-            tenure_type == "RENT_FROM_HA"
-        )
-
-        is_private_rent = tenure_type == "RENT_PRIVATELY"
-
-        obr = parameters.gov.economic_assumptions.indices.obr
-
-        private_rent_uprating = obr.lagged_average_earnings(
-            period
-        ) / obr.lagged_average_earnings(data_year)
-        social_rent_uprating = obr.social_rent(period) / obr.social_rent(
-            data_year
-        )
-
-        return select(
-            [
-                is_social_rent,
-                is_private_rent,
-                True,
-            ],
-            [
-                original_rent * social_rent_uprating,
-                original_rent * private_rent_uprating,
-                original_rent,
-            ],
-        )

{policyengine_uk-2.45.4.dist-info → policyengine_uk-2.47.3.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: policyengine-uk
-Version: 2.45.4
-Summary: PolicyEngine tax and benefit system for the UK
+Version: 2.47.3
+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
 Project-URL: Issues, https://github.com/PolicyEngine/policyengine-uk/issues
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Requires-Python: >=3.10
+Requires-Python: >=3.13
 Requires-Dist: microdf-python>=1.0.2
 Requires-Dist: policyengine-core>=3.19.3
 Requires-Dist: pydantic>=2.11.7
@@ -28,10 +28,11 @@ Provides-Extra: dev
 Requires-Dist: black; extra == 'dev'
 Requires-Dist: coverage; extra == 'dev'
 Requires-Dist: furo<2023; extra == 'dev'
-Requires-Dist: jupyter-book; extra == 'dev'
+Requires-Dist: jupyter-book>=2.0.0a0; extra == 'dev'
 Requires-Dist: linecheck; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: rich; extra == 'dev'
 Requires-Dist: setuptools; extra == 'dev'
 Requires-Dist: snowballstemmer<3,>=2; extra == 'dev'
 Requires-Dist: sphinx-argparse<1,>=0.3.2; extra == 'dev'