policyengine-uk 2.40.1__py3-none-any.whl → 2.65.6__py3-none-any.whl

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

@@ -3,8 +3,15 @@ from policyengine_uk.model_api import *
 
 class employee_pension_contributions(Variable):
     label = "employee pension contributions"
+    documentation = (
+        "Total employee pension contributions including reported contributions "
+        "and any excess salary sacrifice redirected to regular pension contributions."
+    )
     entity = Person
     definition_period = YEAR
     value_type = float
     unit = GBP
-    uprating = "gov.economic_assumptions.indices.obr.average_earnings"
+    adds = [
+        "employee_pension_contributions_reported",
+        "salary_sacrifice_returned_to_income",
+    ]

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

@@ -0,0 +1,16 @@
+from policyengine_uk.model_api import *
+
+
+class employee_pension_contributions_reported(Variable):
+    label = "employee pension contributions (reported)"
+    documentation = (
+        "The reported employee pension contributions from survey data, "
+        "before any adjustments for salary sacrifice cap reforms. "
+        "Note: This variable is populated from the 'employee_pension_contributions' "
+        "field in the microdata via input aliasing."
+    )
+    entity = Person
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "gov.economic_assumptions.indices.obr.average_earnings"

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

@@ -0,0 +1,16 @@
+from policyengine_uk.model_api import *
+
+
+class pension_contributions_via_salary_sacrifice(Variable):
+    label = "Pension contributions via salary sacrifice"
+    documentation = (
+        "Annual amount of pension contributions made through salary sacrifice "
+        "arrangements, where the employee agrees to reduce their gross salary "
+        "in exchange for employer pension contributions"
+    )
+    entity = Person
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    reference = "https://datacatalogue.ukdataservice.ac.uk/datasets/dataset/630d4a8d-ba6a-82b3-f33d-c713c66efcb3"
+    uprating = "gov.economic_assumptions.indices.obr.average_earnings"

policyengine_uk/variables/input/employment_income.py

@@ -14,5 +14,7 @@ class employment_income(Variable):
         "employment_income_before_lsr",
         "employment_income_behavioral_response",
         "employer_ni_fixed_employer_cost_change",
+        "salary_sacrifice_returned_to_income",
+        "salary_sacrifice_broad_base_haircut",
     ]
     uprating = "gov.economic_assumptions.indices.obr.average_earnings"

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/variables/input/savings_interest_income.py

@@ -10,4 +10,6 @@ class savings_interest_income(Variable):
     reference = "Income Tax (Trading and Other Income) Act 2005 s. 365(1)(a)"
     unit = GBP
     quantity_type = FLOW
-    uprating = "gov.economic_assumptions.indices.obr.per_capita.gdp"
+    # Use ONS household interest income growth (D.41g/HAXV series) for uprating
+    # as it captures the significant growth due to interest rate changes
+    uprating = "gov.economic_assumptions.indices.ons.household_interest_income"

{policyengine_uk-2.40.1.dist-info → policyengine_uk-2.65.6.dist-info}/METADATA

@@ -1,30 +1,39 @@
 Metadata-Version: 2.4
 Name: policyengine-uk
-Version: 2.40.1
-Summary: PolicyEngine tax and benefit system for the UK
+Version: 2.65.6
+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
+Project-URL: Changelog, https://github.com/PolicyEngine/policyengine-uk/blob/master/CHANGELOG.md
 Author-email: PolicyEngine <nikhil@policyengine.org>
-Maintainer-email: Nikhil Woodruff <nikhil.woodruff@outlook.com>
-License: AGPL-3.0
+Maintainer-email: Nikhil Woodruff <nikhil@policyengine.org>
+License-Expression: AGPL-3.0
 License-File: LICENSE
 Keywords: benefit,microsimulation,social,tax
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+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-Dist: microdf-python==0.4.4
-Requires-Dist: policyengine-core>=3.6.4
+Requires-Python: <3.14,>=3.13
+Requires-Dist: microdf-python>=1.0.2
+Requires-Dist: policyengine-core>=3.23.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: tables>=3.10.2
 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'