policyengine 3.1.14__tar.gz → 3.1.16__tar.gz

{policyengine-3.1.14 → policyengine-3.1.16}/CHANGELOG.md

@@ -5,6 +5,18 @@ 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).
 
+## [3.1.16] - 2026-01-25 14:20:29
+
+### Changed
+
+- Bumped policyengine-core minimum version to 3.23.5 for pandas 3.0 compatibility
+
+## [3.1.15] - 2025-12-14 23:51:27
+
+### Added
+
+- Household impacts
+
 ## [3.1.14] - 2025-12-10 21:59:24
 
 ### Fixed
@@ -281,6 +293,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+[3.1.16]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.15...3.1.16
+[3.1.15]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.14...3.1.15
 [3.1.14]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.13...3.1.14
 [3.1.13]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.12...3.1.13
 [3.1.12]: https://github.com/PolicyEngine/policyengine.py/compare/3.1.11...3.1.12

{policyengine-3.1.14 → policyengine-3.1.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 3.1.14
+Version: 3.1.16
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -670,15 +670,15 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pandas>=2.0.0
-Requires-Dist: microdf_python
+Requires-Dist: microdf_python>=1.2.1
 Requires-Dist: plotly>=5.0.0
 Requires-Dist: requests>=2.31.0
 Requires-Dist: psutil>=5.9.0
 Provides-Extra: uk
-Requires-Dist: policyengine_core>=3.10; extra == "uk"
+Requires-Dist: policyengine_core>=3.23.6; extra == "uk"
 Requires-Dist: policyengine-uk>=2.51.0; extra == "uk"
 Provides-Extra: us
-Requires-Dist: policyengine_core>=3.10; extra == "us"
+Requires-Dist: policyengine_core>=3.23.6; extra == "us"
 Requires-Dist: policyengine-us>=1.213.1; extra == "us"
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
@@ -691,7 +691,7 @@ Requires-Dist: itables; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.26.0; extra == "dev"
 Requires-Dist: ruff>=0.5.0; extra == "dev"
-Requires-Dist: policyengine_core>=3.10; extra == "dev"
+Requires-Dist: policyengine_core>=3.23.6; extra == "dev"
 Requires-Dist: policyengine-uk>=2.51.0; extra == "dev"
 Requires-Dist: policyengine-us>=1.213.1; extra == "dev"
 Dynamic: license-file

{policyengine-3.1.14 → policyengine-3.1.16}/changelog.yaml

@@ -230,3 +230,13 @@
     fixed:
     - Improvements to loading taxbenefitsystems.
   date: 2025-12-10 21:59:24
+- bump: patch
+  changes:
+    added:
+    - Household impacts
+  date: 2025-12-14 23:51:27
+- bump: patch
+  changes:
+    changed:
+    - Bumped policyengine-core minimum version to 3.23.5 for pandas 3.0 compatibility
+  date: 2026-01-25 14:20:29

policyengine-3.1.16/examples/household_impact_example.py

@@ -0,0 +1,128 @@
+"""Example: Calculate household tax and benefit impacts.
+
+This script demonstrates using calculate_household_impact for both UK and US
+to compute taxes and benefits for custom households.
+
+Run: python examples/household_impact_example.py
+"""
+
+from policyengine.tax_benefit_models.uk import (
+    UKHouseholdInput,
+)
+from policyengine.tax_benefit_models.uk import (
+    calculate_household_impact as calculate_uk_impact,
+)
+from policyengine.tax_benefit_models.us import (
+    USHouseholdInput,
+)
+from policyengine.tax_benefit_models.us import (
+    calculate_household_impact as calculate_us_impact,
+)
+
+
+def uk_example():
+    """UK household impact example."""
+    print("=" * 60)
+    print("UK HOUSEHOLD IMPACT")
+    print("=" * 60)
+
+    # Single adult earning £50,000
+    household = UKHouseholdInput(
+        people=[{"age": 35, "employment_income": 50_000}],
+        year=2026,
+    )
+    result = calculate_uk_impact(household)
+
+    print("\nSingle adult, £50k income:")
+    print(
+        f"  Net income: £{result.household['hbai_household_net_income']:,.0f}"
+    )
+    print(f"  Income tax: £{result.person[0]['income_tax']:,.0f}")
+    print(
+        f"  National Insurance: £{result.person[0]['national_insurance']:,.0f}"
+    )
+    print(f"  Total tax: £{result.household['household_tax']:,.0f}")
+
+    # Family with two children, £30k income, renting
+    household = UKHouseholdInput(
+        people=[
+            {"age": 35, "employment_income": 30_000},
+            {"age": 33},
+            {"age": 8},
+            {"age": 5},
+        ],
+        benunit={
+            "would_claim_uc": True,
+            "would_claim_child_benefit": True,
+        },
+        household={
+            "rent": 12_000,  # £1k/month
+            "region": "NORTH_WEST",
+        },
+        year=2026,
+    )
+    result = calculate_uk_impact(household)
+
+    print("\nFamily (2 adults, 2 children), £30k income, renting:")
+    print(
+        f"  Net income: £{result.household['hbai_household_net_income']:,.0f}"
+    )
+    print(f"  Income tax: £{result.person[0]['income_tax']:,.0f}")
+    print(f"  Child benefit: £{result.benunit[0]['child_benefit']:,.0f}")
+    print(f"  Universal credit: £{result.benunit[0]['universal_credit']:,.0f}")
+    print(f"  Total benefits: £{result.household['household_benefits']:,.0f}")
+
+
+def us_example():
+    """US household impact example."""
+    print("\n" + "=" * 60)
+    print("US HOUSEHOLD IMPACT")
+    print("=" * 60)
+
+    # Single adult earning $50,000
+    household = USHouseholdInput(
+        people=[
+            {"age": 35, "employment_income": 50_000, "is_tax_unit_head": True}
+        ],
+        tax_unit={"filing_status": "SINGLE"},
+        household={"state_code_str": "CA"},
+        year=2024,
+    )
+    result = calculate_us_impact(household)
+
+    print("\nSingle adult, $50k income (California):")
+    print(f"  Net income: ${result.household['household_net_income']:,.0f}")
+    print(f"  Income tax: ${result.tax_unit[0]['income_tax']:,.0f}")
+    print(f"  Payroll tax: ${result.tax_unit[0]['employee_payroll_tax']:,.0f}")
+
+    # Married couple with children, lower income
+    household = USHouseholdInput(
+        people=[
+            {"age": 35, "employment_income": 40_000, "is_tax_unit_head": True},
+            {"age": 33, "is_tax_unit_spouse": True},
+            {"age": 8, "is_tax_unit_dependent": True},
+            {"age": 5, "is_tax_unit_dependent": True},
+        ],
+        tax_unit={"filing_status": "JOINT"},
+        household={"state_code_str": "TX"},
+        year=2024,
+    )
+    result = calculate_us_impact(household)
+
+    print("\nMarried couple with 2 children, $40k income (Texas):")
+    print(f"  Net income: ${result.household['household_net_income']:,.0f}")
+    print(f"  Federal income tax: ${result.tax_unit[0]['income_tax']:,.0f}")
+    print(f"  EITC: ${result.tax_unit[0]['eitc']:,.0f}")
+    print(f"  Child tax credit: ${result.tax_unit[0]['ctc']:,.0f}")
+    print(f"  SNAP: ${result.spm_unit[0]['snap']:,.0f}")
+
+
+def main():
+    uk_example()
+    us_example()
+    print("\n" + "=" * 60)
+    print("Done!")
+
+
+if __name__ == "__main__":
+    main()

{policyengine-3.1.14 → policyengine-3.1.16}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "policyengine"
-version = "3.1.14"
+version = "3.1.16"
 description = "A package to conduct policy analysis using PolicyEngine tax-benefit models."
 readme = "README.md"
 authors = [
@@ -15,7 +15,7 @@ requires-python = ">=3.13"
 dependencies = [
     "pydantic>=2.0.0",
     "pandas>=2.0.0",
-    "microdf_python",
+    "microdf_python>=1.2.1",
     "plotly>=5.0.0",
     "requests>=2.31.0",
     "psutil>=5.9.0",
@@ -23,11 +23,11 @@ dependencies = [
 
 [project.optional-dependencies]
 uk = [
-    "policyengine_core>=3.10",
+    "policyengine_core>=3.23.6",
     "policyengine-uk>=2.51.0",
 ]
 us = [
-    "policyengine_core>=3.10",
+    "policyengine_core>=3.23.6",
     "policyengine-us>=1.213.1",
 ]
 dev = [
@@ -41,7 +41,7 @@ dev = [
     "build",
     "pytest-asyncio>=0.26.0",
     "ruff>=0.5.0",
-    "policyengine_core>=3.10",
+    "policyengine_core>=3.23.6",
     "policyengine-uk>=2.51.0",
     "policyengine-us>=1.213.1",
 ]

{policyengine-3.1.14 → policyengine-3.1.16}/src/policyengine/core/tax_benefit_model_version.py

@@ -24,7 +24,15 @@ class TaxBenefitModelVersion(BaseModel):
 
     variables: list["Variable"] = Field(default_factory=list)
     parameters: list["Parameter"] = Field(default_factory=list)
-    parameter_values: list["ParameterValue"] = Field(default_factory=list)
+
+    @property
+    def parameter_values(self) -> list["ParameterValue"]:
+        """Aggregate all parameter values from all parameters."""
+        return [
+            pv
+            for parameter in self.parameters
+            for pv in parameter.parameter_values
+        ]
 
     # Lookup dicts for O(1) access (excluded from serialization)
     variables_by_name: dict[str, "Variable"] = Field(

policyengine-3.1.16/src/policyengine/outputs/__init__.py

@@ -0,0 +1,49 @@
+from policyengine.core import Output, OutputCollection
+from policyengine.outputs.aggregate import Aggregate, AggregateType
+from policyengine.outputs.change_aggregate import (
+    ChangeAggregate,
+    ChangeAggregateType,
+)
+from policyengine.outputs.decile_impact import (
+    DecileImpact,
+    calculate_decile_impacts,
+)
+from policyengine.outputs.inequality import (
+    UK_INEQUALITY_INCOME_VARIABLE,
+    US_INEQUALITY_INCOME_VARIABLE,
+    Inequality,
+    calculate_uk_inequality,
+    calculate_us_inequality,
+)
+from policyengine.outputs.poverty import (
+    UK_POVERTY_VARIABLES,
+    US_POVERTY_VARIABLES,
+    Poverty,
+    UKPovertyType,
+    USPovertyType,
+    calculate_uk_poverty_rates,
+    calculate_us_poverty_rates,
+)
+
+__all__ = [
+    "Output",
+    "OutputCollection",
+    "Aggregate",
+    "AggregateType",
+    "ChangeAggregate",
+    "ChangeAggregateType",
+    "DecileImpact",
+    "calculate_decile_impacts",
+    "Poverty",
+    "UKPovertyType",
+    "USPovertyType",
+    "UK_POVERTY_VARIABLES",
+    "US_POVERTY_VARIABLES",
+    "calculate_uk_poverty_rates",
+    "calculate_us_poverty_rates",
+    "Inequality",
+    "UK_INEQUALITY_INCOME_VARIABLE",
+    "US_INEQUALITY_INCOME_VARIABLE",
+    "calculate_uk_inequality",
+    "calculate_us_inequality",
+]

{policyengine-3.1.14 → policyengine-3.1.16}/src/policyengine/outputs/decile_impact.py

@@ -2,6 +2,10 @@ import pandas as pd
 from pydantic import ConfigDict
 
 from policyengine.core import Output, OutputCollection, Simulation
+from policyengine.core.dataset import Dataset
+from policyengine.core.dynamic import Dynamic
+from policyengine.core.policy import Policy
+from policyengine.core.tax_benefit_model_version import TaxBenefitModelVersion
 
 
 class DecileImpact(Output):
@@ -93,8 +97,11 @@ class DecileImpact(Output):
 
 
 def calculate_decile_impacts(
-    baseline_simulation: Simulation,
-    reform_simulation: Simulation,
+    dataset: Dataset,
+    tax_benefit_model_version: TaxBenefitModelVersion,
+    baseline_policy: Policy | None = None,
+    reform_policy: Policy | None = None,
+    dynamic: Dynamic | None = None,
     income_variable: str = "equiv_hbai_household_net_income",
     entity: str | None = None,
     quantiles: int = 10,
@@ -104,6 +111,19 @@ def calculate_decile_impacts(
     Returns:
         OutputCollection containing list of DecileImpact objects and DataFrame
     """
+    baseline_simulation = Simulation(
+        dataset=dataset,
+        tax_benefit_model_version=tax_benefit_model_version,
+        policy=baseline_policy,
+        dynamic=dynamic,
+    )
+    reform_simulation = Simulation(
+        dataset=dataset,
+        tax_benefit_model_version=tax_benefit_model_version,
+        policy=reform_policy,
+        dynamic=dynamic,
+    )
+
     results = []
     for decile in range(1, quantiles + 1):
         impact = DecileImpact(

policyengine-3.1.16/src/policyengine/outputs/inequality.py

@@ -0,0 +1,276 @@
+"""Inequality analysis output types."""
+
+from typing import Any
+
+import numpy as np
+import pandas as pd
+from pydantic import ConfigDict
+
+from policyengine.core import Output, Simulation
+
+
+def _gini(values: np.ndarray, weights: np.ndarray) -> float:
+    """Calculate weighted Gini coefficient.
+
+    Args:
+        values: Array of income values
+        weights: Array of weights
+
+    Returns:
+        Gini coefficient between 0 (perfect equality) and 1 (perfect inequality)
+    """
+    # Handle edge cases
+    if len(values) == 0 or weights.sum() == 0:
+        return 0.0
+
+    # Sort by values
+    sorted_indices = np.argsort(values)
+    sorted_values = values[sorted_indices]
+    sorted_weights = weights[sorted_indices]
+
+    # Cumulative weights and weighted values
+    cumulative_weights = np.cumsum(sorted_weights)
+    total_weight = cumulative_weights[-1]
+    cumulative_weighted_values = np.cumsum(sorted_values * sorted_weights)
+    total_weighted_value = cumulative_weighted_values[-1]
+
+    if total_weighted_value == 0:
+        return 0.0
+
+    # Calculate Gini using the area formula
+    # Gini = 1 - 2 * (area under Lorenz curve)
+    lorenz_curve = cumulative_weighted_values / total_weighted_value
+    weight_fractions = sorted_weights / total_weight
+
+    # Area under Lorenz curve using trapezoidal rule
+    area = np.sum(weight_fractions * (lorenz_curve - weight_fractions / 2))
+
+    return float(1 - 2 * area)
+
+
+class Inequality(Output):
+    """Single inequality measure result - represents one database row.
+
+    This is a single-simulation output type that calculates inequality
+    metrics for a given income variable, optionally filtered by
+    demographic variables.
+    """
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    simulation: Simulation
+    income_variable: str
+    entity: str = "household"
+
+    # Optional demographic filters
+    filter_variable: str | None = None
+    filter_variable_eq: Any | None = None
+    filter_variable_leq: Any | None = None
+    filter_variable_geq: Any | None = None
+
+    # Results populated by run()
+    gini: float | None = None
+    top_10_share: float | None = None
+    top_1_share: float | None = None
+    bottom_50_share: float | None = None
+
+    def run(self):
+        """Calculate inequality metrics."""
+        # Get income variable info
+        income_var_obj = (
+            self.simulation.tax_benefit_model_version.get_variable(
+                self.income_variable
+            )
+        )
+
+        # Get target entity data
+        target_entity = self.entity
+        data = getattr(self.simulation.output_dataset.data, target_entity)
+
+        # Map income variable to target entity if needed
+        if income_var_obj.entity != target_entity:
+            mapped = self.simulation.output_dataset.data.map_to_entity(
+                income_var_obj.entity,
+                target_entity,
+                columns=[self.income_variable],
+            )
+            income_series = mapped[self.income_variable]
+        else:
+            income_series = data[self.income_variable]
+
+        # Get weights
+        weight_col = f"{target_entity}_weight"
+        if weight_col in data.columns:
+            weights = data[weight_col]
+        else:
+            weights = pd.Series(np.ones(len(income_series)))
+
+        # Apply demographic filter if specified
+        if self.filter_variable is not None:
+            filter_var_obj = (
+                self.simulation.tax_benefit_model_version.get_variable(
+                    self.filter_variable
+                )
+            )
+
+            if filter_var_obj.entity != target_entity:
+                filter_mapped = (
+                    self.simulation.output_dataset.data.map_to_entity(
+                        filter_var_obj.entity,
+                        target_entity,
+                        columns=[self.filter_variable],
+                    )
+                )
+                filter_series = filter_mapped[self.filter_variable]
+            else:
+                filter_series = data[self.filter_variable]
+
+            # Build filter mask
+            mask = filter_series.notna()
+            if self.filter_variable_eq is not None:
+                mask &= filter_series == self.filter_variable_eq
+            if self.filter_variable_leq is not None:
+                mask &= filter_series <= self.filter_variable_leq
+            if self.filter_variable_geq is not None:
+                mask &= filter_series >= self.filter_variable_geq
+
+            # Apply mask
+            income_series = income_series[mask]
+            weights = weights[mask]
+
+        # Convert to numpy arrays
+        values = np.array(income_series)
+        weights_arr = np.array(weights)
+
+        # Remove NaN values
+        valid_mask = ~np.isnan(values) & ~np.isnan(weights_arr)
+        values = values[valid_mask]
+        weights_arr = weights_arr[valid_mask]
+
+        # Calculate Gini coefficient
+        self.gini = _gini(values, weights_arr)
+
+        # Calculate income shares
+        if len(values) > 0 and weights_arr.sum() > 0:
+            total_income = np.sum(values * weights_arr)
+
+            if total_income > 0:
+                # Sort by income
+                sorted_indices = np.argsort(values)
+                sorted_values = values[sorted_indices]
+                sorted_weights = weights_arr[sorted_indices]
+
+                # Cumulative weight fractions
+                cumulative_weights = np.cumsum(sorted_weights)
+                total_weight = cumulative_weights[-1]
+                weight_fractions = cumulative_weights / total_weight
+
+                # Top 10% share
+                top_10_mask = weight_fractions > 0.9
+                self.top_10_share = float(
+                    np.sum(
+                        sorted_values[top_10_mask]
+                        * sorted_weights[top_10_mask]
+                    )
+                    / total_income
+                )
+
+                # Top 1% share
+                top_1_mask = weight_fractions > 0.99
+                self.top_1_share = float(
+                    np.sum(
+                        sorted_values[top_1_mask] * sorted_weights[top_1_mask]
+                    )
+                    / total_income
+                )
+
+                # Bottom 50% share
+                bottom_50_mask = weight_fractions <= 0.5
+                self.bottom_50_share = float(
+                    np.sum(
+                        sorted_values[bottom_50_mask]
+                        * sorted_weights[bottom_50_mask]
+                    )
+                    / total_income
+                )
+            else:
+                self.top_10_share = 0.0
+                self.top_1_share = 0.0
+                self.bottom_50_share = 0.0
+        else:
+            self.top_10_share = 0.0
+            self.top_1_share = 0.0
+            self.bottom_50_share = 0.0
+
+
+# Default income variables for each country
+UK_INEQUALITY_INCOME_VARIABLE = "equiv_hbai_household_net_income"
+US_INEQUALITY_INCOME_VARIABLE = "household_net_income"
+
+
+def calculate_uk_inequality(
+    simulation: Simulation,
+    income_variable: str = UK_INEQUALITY_INCOME_VARIABLE,
+    filter_variable: str | None = None,
+    filter_variable_eq: Any | None = None,
+    filter_variable_leq: Any | None = None,
+    filter_variable_geq: Any | None = None,
+) -> Inequality:
+    """Calculate inequality metrics for a UK simulation.
+
+    Args:
+        simulation: The simulation to analyse
+        income_variable: Income variable to use (default: equiv_hbai_household_net_income)
+        filter_variable: Optional variable to filter by
+        filter_variable_eq: Filter for exact match
+        filter_variable_leq: Filter for less than or equal
+        filter_variable_geq: Filter for greater than or equal
+
+    Returns:
+        Inequality object with Gini and income share metrics
+    """
+    inequality = Inequality(
+        simulation=simulation,
+        income_variable=income_variable,
+        entity="household",
+        filter_variable=filter_variable,
+        filter_variable_eq=filter_variable_eq,
+        filter_variable_leq=filter_variable_leq,
+        filter_variable_geq=filter_variable_geq,
+    )
+    inequality.run()
+    return inequality
+
+
+def calculate_us_inequality(
+    simulation: Simulation,
+    income_variable: str = US_INEQUALITY_INCOME_VARIABLE,
+    filter_variable: str | None = None,
+    filter_variable_eq: Any | None = None,
+    filter_variable_leq: Any | None = None,
+    filter_variable_geq: Any | None = None,
+) -> Inequality:
+    """Calculate inequality metrics for a US simulation.
+
+    Args:
+        simulation: The simulation to analyse
+        income_variable: Income variable to use (default: household_net_income)
+        filter_variable: Optional variable to filter by
+        filter_variable_eq: Filter for exact match
+        filter_variable_leq: Filter for less than or equal
+        filter_variable_geq: Filter for greater than or equal
+
+    Returns:
+        Inequality object with Gini and income share metrics
+    """
+    inequality = Inequality(
+        simulation=simulation,
+        income_variable=income_variable,
+        entity="household",
+        filter_variable=filter_variable,
+        filter_variable_eq=filter_variable_eq,
+        filter_variable_leq=filter_variable_leq,
+        filter_variable_geq=filter_variable_geq,
+    )
+    inequality.run()
+    return inequality