policyengine-uk 2.35.0__py3-none-any.whl

policyengine_uk/variables/household/income/minimum_wage.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class minimum_wage(Variable):
+    value_type = float
+    entity = Person
+    label = "Minimum wage"
+    definition_period = YEAR
+    unit = GBP
+
+    def formula(person, period, parameters):
+        MW = parameters(period).gov.hmrc.minimum_wage
+        return MW[person("minimum_wage_category", period)]

policyengine_uk/variables/household/income/minimum_wage_category.py

@@ -0,0 +1,41 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class MinimumWageCategory(Enum):
+    APPRENTICE = "Apprentice"
+    UNDER_18 = "Under 18"
+    BETWEEN_18_20 = "18 to 20"
+    BETWEEN_21_22 = "21 to 22"
+    BETWEEN_23_24 = "23 to 24"
+    OVER_24 = "25 or over"
+
+
+class minimum_wage_category(Variable):
+    value_type = Enum
+    possible_values = MinimumWageCategory
+    default_value = MinimumWageCategory.OVER_24
+    entity = Person
+    label = "Minimum wage category"
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        age = person("age", period)
+        return select(
+            [
+                person("is_apprentice", period),
+                age < 18,
+                (age >= 18) & (age <= 20),
+                (age >= 21) & (age <= 22),
+                (age >= 23) & (age <= 24),
+            ],
+            [
+                MinimumWageCategory.APPRENTICE,
+                MinimumWageCategory.UNDER_18,
+                MinimumWageCategory.BETWEEN_18_20,
+                MinimumWageCategory.BETWEEN_21_22,
+                MinimumWageCategory.BETWEEN_23_24,
+            ],
+            default=MinimumWageCategory.OVER_24,
+        )

policyengine_uk/variables/household/income/poverty_gap.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_gap(Variable):
+    label = "poverty gap"
+    documentation = "The financial gap between net household income and the poverty line (before housing costs)."
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    def formula(household, period, parameters):
+        income = household("hbai_household_net_income", period)
+        line = household("poverty_line", period)
+        return max_(0, line - income)

policyengine_uk/variables/household/income/poverty_gap_ahc.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_gap_ahc(Variable):
+    value_type = float
+    entity = Household
+    label = "Positive financial gap between net household income and the poverty line, after housing costs"
+    definition_period = YEAR
+
+    def formula(household, period, parameters):
+        net_income = household("hbai_household_net_income_ahc", period)
+        return max_(0, household("poverty_line_ahc", period) - net_income)

policyengine_uk/variables/household/income/poverty_gap_bhc.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_gap_bhc(Variable):
+    value_type = float
+    entity = Household
+    label = "Positive financial gap between net household income and the poverty line"
+    definition_period = YEAR
+
+    def formula(household, period, parameters):
+        net_income = household("hbai_household_net_income", period)
+        return max_(0, household("poverty_line_bhc", period) - net_income)

policyengine_uk/variables/household/income/poverty_line.py

@@ -0,0 +1,18 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_line(Variable):
+    label = "poverty line"
+    documentation = "The line below which a household is in poverty."
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    def formula(household, period, parameters):
+        equivalisation = household("household_equivalisation_bhc", period)
+        return (
+            parameters(period).household.poverty.absolute_poverty_threshold_bhc
+            * WEEKS_IN_YEAR
+            * equivalisation
+        )

policyengine_uk/variables/household/income/poverty_line_ahc.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_line_ahc(Variable):
+    value_type = float
+    entity = Household
+    label = "The poverty line for the household, after housing costs"
+    definition_period = YEAR
+
+    def formula(household, period, parameters):
+        threshold = parameters(
+            period
+        ).household.poverty.absolute_poverty_threshold_ahc
+        equivalisation = household("household_equivalisation_ahc", period)
+        return threshold * equivalisation * WEEKS_IN_YEAR

policyengine_uk/variables/household/income/poverty_line_bhc.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_line_bhc(Variable):
+    value_type = float
+    entity = Household
+    label = "The poverty line for the household, before housing costs"
+    definition_period = YEAR
+
+    def formula(household, period, parameters):
+        threshold = parameters(
+            period
+        ).household.poverty.absolute_poverty_threshold_bhc
+        equivalisation = household("household_equivalisation_bhc", period)
+        return threshold * equivalisation * WEEKS_IN_YEAR

policyengine_uk/variables/household/income/poverty_threshold_bhc.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+
+
+class poverty_threshold_bhc(Variable):
+    label = "Poverty threshold (BHC)"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    def formula(household, period, parameters):
+        return (
+            parameters(period).household.poverty.absolute_poverty_threshold_bhc
+            * WEEKS_IN_YEAR
+        )

policyengine_uk/variables/household/income/real_household_net_income.py

@@ -0,0 +1,17 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class real_household_net_income(Variable):
+    label = (
+        f"real household net income ({datetime.datetime.now().year} prices)"
+    )
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    def formula(household, period, parameters):
+        net_income = household("household_net_income", period)
+        return net_income * household("inflation_adjustment", period)

policyengine_uk/variables/household/income/real_household_net_income_ahc.py

@@ -0,0 +1,17 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class real_household_net_income_ahc(Variable):
+    label = (
+        f"real household net income ({datetime.datetime.now().year} prices)"
+    )
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    def formula(household, period, parameters):
+        net_income = household("household_net_income_ahc", period)
+        return net_income * household("inflation_adjustment", period)

policyengine_uk/variables/household/income/statutory_maternity_pay.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class statutory_maternity_pay(Variable):
+    label = "Statutory maternity pay"
+    entity = Person
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/household/income/statutory_paternity_pay.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class statutory_paternity_pay(Variable):
+    label = "Statutory paternity pay"
+    entity = Person
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/household/income/statutory_sick_pay.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class statutory_sick_pay(Variable):
+    label = "Statutory sick pay"
+    entity = Person
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/household/income/weekly_hours.py

@@ -0,0 +1,16 @@
+from policyengine_uk.model_api import *
+import datetime
+import numpy as np
+
+
+class weekly_hours(Variable):
+    value_type = float
+    entity = Person
+    label = "Weekly hours"
+    documentation = "Average weekly hours worked"
+    definition_period = YEAR
+    unit = "hour"
+    quantity_type = FLOW
+
+    def formula(person, period, parameters):
+        return person("hours_worked", period) / WEEKS_IN_YEAR

policyengine_uk/variables/household/is_on_cliff.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+
+
+class is_on_cliff(Variable):
+    value_type = bool
+    entity = Person
+    label = "is on a tax-benefit cliff"
+    documentation = "Whether this person would be worse off if their employment income were higher by delta amount."
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        return person("cliff_gap", period) > 0

policyengine_uk/variables/household/marginal_tax_rate.py

@@ -0,0 +1,50 @@
+from policyengine_uk.model_api import *
+from policyengine_core.variables import Variable
+
+
+class marginal_tax_rate(Variable):
+    label = "Marginal tax rate"
+    documentation = "Percent of marginal income gains that do not increase household net income."
+    entity = Person
+    definition_period = YEAR
+    value_type = float
+    unit = "/1"
+
+    def formula(person, period, parameters):
+        p = parameters(period).gov.simulation
+        mtr_values = np.zeros(person.count, dtype=np.float32)
+        simulation = person.simulation
+        adult_index_values = person("adult_index", period)
+        delta = p.marginal_tax_rate_delta
+        adult_count = p.marginal_tax_rate_adults
+        for adult_index in range(1, 1 + adult_count):
+            alt_simulation = simulation.get_branch(
+                f"adult_{adult_index}_pay_rise"
+            )
+            mask = adult_index_values == adult_index
+            for variable in simulation.tax_benefit_system.variables:
+                variable_data = simulation.tax_benefit_system.variables[
+                    variable
+                ]
+                if (
+                    variable not in simulation.input_variables
+                    and not variable_data.is_input_variable()
+                ):
+                    alt_simulation.delete_arrays(variable)
+            alt_simulation.set_input(
+                "employment_income",
+                period,
+                person("employment_income", period) + mask * delta,
+            )
+            alt_person = alt_simulation.person
+            household_net_income = person.household(
+                "household_net_income", period
+            )
+            household_net_income_higher_earnings = alt_person.household(
+                "household_net_income", period
+            )
+            increase = (
+                household_net_income_higher_earnings - household_net_income
+            )
+            mtr_values += where(mask, 1 - increase / delta, 0)
+        return mtr_values

policyengine_uk/variables/household/region.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+from policyengine_uk.variables.household.demographic.locations import BRMAName
+from policyengine_uk.variables.household.demographic.geography import Region
+import pandas as pd
+import numpy as np
+
+
+class region(Variable):
+    value_type = Enum
+    possible_values = Region
+    default_value = Region.LONDON
+    entity = Household
+    label = "region"
+    documentation = "Area of the UK"
+    definition_period = YEAR

policyengine_uk/variables/household/wealth/corporate_land_value.py

@@ -0,0 +1,20 @@
+from policyengine_uk.model_api import *
+
+
+class corporate_land_value(Variable):
+    entity = Household
+    label = "Land value"
+    documentation = "Estimated total land value indirectly owned by the household from corporate holdings"
+    unit = GBP
+    definition_period = YEAR
+    value_type = float
+    quantity_type = STOCK
+
+    def formula(household, period, parameters):
+        wealth = parameters(period).household.wealth
+        corporate_wealth = household("corporate_wealth", period)
+        corporate_wealth_intensity = (
+            wealth.land.value.aggregate_corporate_land_value
+            / wealth.corporate_wealth
+        )
+        return corporate_wealth * corporate_wealth_intensity

policyengine_uk/variables/household/wealth/corporate_tax_incidence.py

@@ -0,0 +1,17 @@
+from policyengine_uk.model_api import *
+
+
+class corporate_tax_incidence(Variable):
+    label = "Corporate tax incidence"
+    documentation = (
+        "Reduction in value of corporate wealth due to taxes on corporations"
+    )
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    adds = [
+        "corporate_sdlt",
+        "business_rates",
+    ]

policyengine_uk/variables/household/wealth/gross_financial_wealth.py

@@ -0,0 +1,10 @@
+from policyengine_uk.model_api import *
+
+
+class gross_financial_wealth(Variable):
+    label = "Gross financial wealth"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "household.wealth.financial_assets"

policyengine_uk/variables/household/wealth/household_land_value.py

@@ -0,0 +1,23 @@
+from policyengine_uk.model_api import *
+
+
+class household_land_value(Variable):
+    entity = Household
+    label = "Land value"
+    documentation = (
+        "Estimated total land value directly owned by the household"
+    )
+    unit = GBP
+    definition_period = YEAR
+    value_type = float
+    quantity_type = STOCK
+
+    def formula(household, period, parameters):
+        wealth = parameters(period).household.wealth
+        property_wealth_intensity = (
+            wealth.land.value.aggregate_household_land_value
+            / wealth.property_wealth
+        )
+        property_wealth = household("property_wealth", period)
+        owned_land = household("owned_land", period)
+        return property_wealth * property_wealth_intensity + owned_land

policyengine_uk/variables/household/wealth/household_wealth_decile.py

@@ -0,0 +1,22 @@
+from policyengine_uk.model_api import *
+
+
+class household_wealth_decile(Variable):
+    label = "household wealth decile"
+    documentation = "Decile of wealth income (person-weighted)"
+    entity = Household
+    definition_period = YEAR
+    value_type = int
+
+    def formula(household, period, parameters):
+        wealth = household("total_wealth", period)
+        count_people = household("household_count_people", period)
+        household_weight = household("household_weight", period)
+        weighted_wealth = MicroSeries(
+            wealth, weights=household_weight * count_people
+        )
+        decile = weighted_wealth.decile_rank().values
+        # Set negatives to -1.
+        # This avoids the bottom decile summing to a negative number,
+        # which would flip the % change in the interface.
+        return where(wealth < 0, -1, decile)

policyengine_uk/variables/household/wealth/land_value.py

@@ -0,0 +1,15 @@
+from policyengine_uk.model_api import *
+
+
+class land_value(Variable):
+    label = "Land value"
+    documentation = (
+        "Estimated total land value (directly and indirectly owned)"
+    )
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    quantity_type = STOCK
+
+    adds = ["household_land_value", "corporate_land_value"]

policyengine_uk/variables/household/wealth/net_financial_wealth.py

@@ -0,0 +1,10 @@
+from policyengine_uk.model_api import *
+
+
+class net_financial_wealth(Variable):
+    label = "Net financial wealth"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "household.wealth.financial_assets"

policyengine_uk/variables/household/wealth/property_wealth.py

@@ -0,0 +1,12 @@
+from policyengine_uk.model_api import *
+
+
+class property_wealth(Variable):
+    label = "Property wealth"
+    documentation = "Total property wealth across all owned properties"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    quantity_type = STOCK
+    adds = ["residential_property_value", "non_residential_property_value"]

policyengine_uk/variables/household/wealth/residential_property_value.py

@@ -0,0 +1,13 @@
+from policyengine_uk.model_api import *
+
+
+class residential_property_value(Variable):
+    label = "Residential property value"
+    documentation = "Total value of all owned residential property"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    quantity_type = STOCK
+
+    adds = ["main_residence_value", "other_residential_property_value"]

policyengine_uk/variables/household/wealth/savings.py

@@ -0,0 +1,11 @@
+from policyengine_uk.model_api import *
+
+
+class savings(Variable):
+    label = "Savings"
+    documentation = "Household liquid savings"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+    uprating = "household.wealth.financial_assets"

policyengine_uk/variables/household/wealth/shareholding.py

@@ -0,0 +1,24 @@
+from policyengine_uk.model_api import *
+
+
+class shareholding(Variable):
+    label = "Share in the corporate sector"
+    documentation = "Exposure to taxes on corporations"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    def formula(household, period, parameters):
+        wealth = household("corporate_wealth", period)
+        if (
+            household.simulation.dataset is not None
+            and household("corporate_wealth", period).sum() != 0
+        ):
+            weight = household("household_weight", period)
+            return wealth / (wealth * weight).sum()
+        wealth = parameters(period).household.wealth
+        nbs = wealth.national_balance_sheet
+        wealth = household("corporate_wealth", period)
+        total_wealth = nbs.household.financial_net_worth
+        return wealth / total_wealth

policyengine_uk/variables/household/wealth/total_wealth.py

@@ -0,0 +1,11 @@
+from policyengine_uk.model_api import *
+
+
+class total_wealth(Variable):
+    label = "Total wealth"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = GBP
+
+    adds = ["property_wealth", "corporate_wealth"]

policyengine_uk/variables/input/README.md

@@ -0,0 +1 @@
+# Inputs

policyengine_uk/variables/input/care.py

@@ -0,0 +1,14 @@
+from policyengine_uk.model_api import *
+
+label = "Care"
+
+
+class receives_carers_allowance(Variable):
+    value_type = bool
+    entity = Person
+    label = "receives Carer's Allowance"
+    documentation = "Whether this person receives Carer's Allowance."
+    definition_period = YEAR
+
+    def formula(person, period, parameters):
+        return person("carers_allowance", period) > 0

policyengine_uk/variables/input/consumption/README.md

@@ -0,0 +1 @@
+# Consumption

policyengine_uk/variables/input/consumption/alcohol_and_tobacco_consumption.py

@@ -0,0 +1,14 @@
+from policyengine_uk.model_api import *
+
+# The below variables follow the COICOP MECE categories.
+
+
+class alcohol_and_tobacco_consumption(Variable):
+    entity = Household
+    label = "alcohol and tobacco consumption"
+    documentation = "Total yearly expenditure on alcohol and tobacco"
+    unit = GBP
+    definition_period = YEAR
+    value_type = float
+    quantity_type = FLOW
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/input/consumption/childcare_expenses.py

@@ -0,0 +1,13 @@
+from policyengine_uk.model_api import *
+
+# The below variables follow the COICOP MECE categories.
+
+
+class childcare_expenses(Variable):
+    value_type = float
+    entity = Person
+    label = "childcare consumption"
+    documentation = "Total amount spent on childcare"
+    definition_period = YEAR
+    unit = GBP
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/input/consumption/clothing_and_footwear_consumption.py

@@ -0,0 +1,14 @@
+from policyengine_uk.model_api import *
+
+# The below variables follow the COICOP MECE categories.
+
+
+class clothing_and_footwear_consumption(Variable):
+    entity = Household
+    label = "clothing and footwear consumption"
+    documentation = "Total yearly expenditure on clothing and footwear"
+    unit = GBP
+    definition_period = YEAR
+    value_type = float
+    quantity_type = FLOW
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/input/consumption/communication_consumption.py

@@ -0,0 +1,14 @@
+from policyengine_uk.model_api import *
+
+# The below variables follow the COICOP MECE categories.
+
+
+class communication_consumption(Variable):
+    entity = Household
+    label = "communication consumption"
+    documentation = "Total yearly expenditure on communication"
+    unit = GBP
+    definition_period = YEAR
+    value_type = float
+    quantity_type = FLOW
+    uprating = "gov.obr.consumer_price_index"

policyengine_uk/variables/input/consumption/consumption.py

@@ -0,0 +1,25 @@
+from policyengine_uk.model_api import *
+
+# The below variables follow the COICOP MECE categories.
+
+
+class consumption(Variable):
+    label = "consumption"
+    entity = Household
+    definition_period = YEAR
+    value_type = float
+    unit = "currency-GBP"
+    adds = [
+        "food_and_non_alcoholic_beverages_consumption",
+        "alcohol_and_tobacco_consumption",
+        "clothing_and_footwear_consumption",
+        "housing_water_and_electricity_consumption",
+        "household_furnishings_consumption",
+        "health_consumption",
+        "transport_consumption",
+        "communication_consumption",
+        "recreation_consumption",
+        "education_consumption",
+        "restaurants_and_hotels_consumption",
+        "miscellaneous_consumption",
+    ]