policyengine-us 1.387.3__py3-none-any.whl → 1.389.0__py3-none-any.whl

policyengine_us/tests/policy/baseline/gov/local/ca/riv/general_relief/integration.yaml

@@ -0,0 +1,88 @@
+- name: Case 1, household of 2 with no income. 
+  period: 2024-01
+  input: 
+    people:
+      person1:
+        age: 30
+        employment_income: 0
+        ssi: 0
+      person2:
+        age: 65
+        employment_income: 0
+        ssi: 0
+        is_incapable_of_self_care: true
+    households:
+      household:
+        members: [person1, person2]
+        in_riv: true
+    spm_units:
+      spm_unit:
+        members: [person1, person2]
+        ca_tanf: 0
+        housing_cost: 300 * 12
+  output:
+    ca_riv_general_relief_eligible: true
+    ca_riv_general_relief: 438.5 
+    # 436 + 30/12 
+    ## $30 annual special needs amount
+
+- name: Case 2, household of 2 with $500 monthly income. 
+  period: 2024-01
+  absolute_error_margin: 0.2
+  input: 
+    people:
+      person1:
+        age: 30
+        employment_income: 500 * 12
+        ssi: 0
+      person2:
+        age: 65
+        employment_income: 0
+        ssi: 0
+    households:
+      household:
+        members: [person1, person2]
+        in_riv: true
+    spm_units:
+      spm_unit:
+        members: [person1, person2]
+        ca_tanf: 0
+        housing_cost: 300 * 12
+  output:
+    state_withheld_income_tax: 0.38
+    ca_riv_general_relief_earned_income_deductions: [38.63, 0.38]
+    ca_riv_general_relief_countable_income: 461.37 # 500 - 38.63
+    ca_riv_general_relief_needs_standards: 436
+    ca_riv_general_relief_income_eligible: false 
+
+- name: Case 3, household of 2 with $450 monthly income. 
+  period: 2024-01
+  absolute_error_margin: 0.2
+  input: 
+    people:
+      person1:
+        age: 30
+        employment_income: 450 * 12
+        ssi: 0
+      person2:
+        age: 65
+        employment_income: 0
+        ssi: 0
+    households:
+      household:
+        members: [person1, person2]
+        in_riv: true
+    spm_units:
+      spm_unit:
+        members: [person1, person2]
+        ca_tanf: 0
+        housing_cost: 300 * 12
+  output:
+    ca_riv_general_relief_earned_income_deductions: [34.43, 0]
+    ca_riv_general_relief_countable_income: 415.57 # 450 - 34.43
+    ca_riv_general_relief_needs_standards: 436
+    ca_riv_general_relief_income_eligible: true
+    ca_riv_general_relief_eligible: true
+    ca_riv_general_relief_special_needs_amount: 2.5
+    ca_riv_general_relief: 22.93
+    # 436 + 2.5 - 415.57

policyengine_us/tests/policy/baseline/gov/states/il/dceo/liheap/eligibility/il_liheap_eligible.yaml

@@ -0,0 +1,54 @@
+- name: Income eligible household with own heating is eligible
+  period: 2024
+  input:
+    state_code: IL
+    il_liheap_income_eligible: true
+    heat_expense_included_in_rent: false
+    rent: 1_000
+    irs_gross_income: 30_000
+  output:
+    il_liheap_eligible: true
+
+- name: Income eligible renter with heat in rent and rent > 30% income is eligible  
+  period: 2024
+  input:
+    state_code: IL
+    il_liheap_income_eligible: true
+    heat_expense_included_in_rent: true
+    rent: 10_000  # Annual rent
+    irs_gross_income: 30_000  # Rent is 33.3% of income
+  output:
+    il_liheap_eligible: true
+
+- name: Income eligible renter with heat in rent but rent < 30% income is not eligible
+  period: 2024
+  input:
+    state_code: IL
+    il_liheap_income_eligible: true
+    heat_expense_included_in_rent: true
+    rent: 5_000  # Annual rent
+    irs_gross_income: 30_000  # Rent is 16.7% of income
+  output:
+    il_liheap_eligible: false
+
+- name: Income eligible renter with heat in rent and rent exactly 30% income is not eligible
+  period: 2024
+  input:
+    state_code: IL
+    il_liheap_income_eligible: true
+    heat_expense_included_in_rent: true
+    rent: 9_000  # Annual rent
+    irs_gross_income: 30_000  # Rent is exactly 30% of income
+  output:
+    il_liheap_eligible: false
+
+- name: Not income eligible is not eligible regardless of rent
+  period: 2024
+  input:
+    state_code: IL
+    il_liheap_income_eligible: false
+    heat_expense_included_in_rent: false
+    rent: 1_000
+    irs_gross_income: 100_000
+  output:
+    il_liheap_eligible: false

policyengine_us/tests/policy/baseline/gov/states/il/dceo/liheap/eligibility/il_liheap_income_eligible.yaml

@@ -0,0 +1,58 @@
+- name: Single person below 60% SMI is eligible
+  period: 2024
+  input:
+    state_code: IL
+    irs_gross_income: 25_000
+    # smi and fpg computed automatically from household size
+  output:
+    il_liheap_income_eligible: true
+
+- name: Single person above 60% SMI but below 200% FPG is eligible
+  period: 2024
+  input:
+    state_code: IL
+    irs_gross_income: 28_000  
+    # Person below 200% FPG so should be eligible
+  output:
+    il_liheap_income_eligible: true
+
+- name: Family of 4 below income limits is eligible
+  period: 2024
+  input:
+    people:
+      parent1:
+        irs_gross_income: 30_000
+      parent2:
+        irs_gross_income: 15_000
+      child1:
+        age: 10
+      child2:
+        age: 5
+    spm_units:
+      spm_unit:
+        members: [parent1, parent2, child1, child2]
+    households:
+      household:
+        members: [parent1, parent2, child1, child2]
+        state_code: IL
+    # smi and fpg computed automatically from spm_unit_size
+  output:
+    il_liheap_income_eligible: true
+
+- name: High income household not eligible
+  period: 2024
+  input:
+    state_code: IL
+    irs_gross_income: 100_000
+    # High income above both limits
+  output:
+    il_liheap_income_eligible: false
+
+- name: Income exactly at 200% FPG is eligible
+  period: 2024
+  input:
+    state_code: IL
+    irs_gross_income: 30_120  # Exactly 200% of FPG
+    # Exactly at 200% FPG limit
+  output:
+    il_liheap_income_eligible: true

policyengine_us/tests/policy/baseline/gov/states/il/dceo/liheap/integration.yaml

@@ -0,0 +1,149 @@
+- name: Senior citizen with disability priority group
+  period: 2024
+  input:
+    people:
+      senior:
+        age: 65
+        is_disabled: true
+        social_security: 12_000
+        irs_gross_income: 12_000
+        rent: 6_000
+        heating_expense_person: 800
+    tax_units:
+      tax_unit:
+        members: [senior]
+    spm_units:
+      spm_unit:
+        members: [senior]
+        heat_expense_included_in_rent: false
+    households:
+      household:
+        members: [senior]
+        state_code: IL
+  output:
+    il_liheap_income_eligible: true
+    il_liheap_eligible: true
+    il_liheap_base_payment: 800  # Based on heating expenses
+    il_liheap: 800  # Base payment only (no crisis assistance)
+
+- name: Family with young children priority group
+  period: 2024
+  input:
+    people:
+      parent1:
+        age: 30
+        employment_income: 25_000
+        irs_gross_income: 25_000
+        rent: 12_000
+        heating_expense_person: 900  # Half of family heating costs
+      parent2:
+        age: 28
+        employment_income: 20_000
+        irs_gross_income: 20_000
+        heating_expense_person: 900  # Half of family heating costs
+      child1:
+        age: 4  # Under 5 - priority group
+        heating_expense_person: 0
+      child2:
+        age: 2  # Under 5 - priority group
+        heating_expense_person: 0
+    tax_units:
+      tax_unit:
+        members: [parent1, parent2, child1, child2]
+    spm_units:
+      spm_unit:
+        members: [parent1, parent2, child1, child2]
+        heat_expense_included_in_rent: false
+    households:
+      household:
+        members: [parent1, parent2, child1, child2]
+        state_code: IL
+  output:
+    il_liheap_income_eligible: true  # 45k total income eligible
+    il_liheap_eligible: true
+    il_liheap_base_payment: 1_800  # Based on heating expenses
+    il_liheap: 1_800  # Base payment only (no crisis assistance)
+
+- name: Renter with heat included must meet rent threshold
+  period: 2024
+  input:
+    people:
+      renter:
+        age: 35
+        employment_income: 24_000
+        irs_gross_income: 24_000
+        rent: 8_000  # 33.3% of income
+        heating_expense_person: 1_200  # Irrelevant for heat included
+    tax_units:
+      tax_unit:
+        members: [renter]
+    spm_units:
+      spm_unit:
+        members: [renter]
+        heat_expense_included_in_rent: true
+    households:
+      household:
+        members: [renter]
+        state_code: IL
+  output:
+    il_liheap_income_eligible: true  # 24k < 60% of 50k (30k)
+    il_liheap_eligible: true  # Rent (8k) > 30% of income (7.2k)
+    il_liheap_base_payment: 315  # Fixed minimum for heat included
+    il_liheap: 315  # Base payment only (no crisis assistance)
+
+- name: Renter with heat included but low rent not eligible
+  period: 2024
+  input:
+    people:
+      renter:
+        age: 40
+        employment_income: 28_000
+        irs_gross_income: 28_000
+        rent: 7_000  # 25% of income
+        heating_expense_person: 1_000  # Irrelevant for heat included
+    tax_units:
+      tax_unit:
+        members: [renter]
+    spm_units:
+      spm_unit:
+        members: [renter]
+        heat_expense_included_in_rent: true
+    households:
+      household:
+        members: [renter]
+        state_code: IL
+  output:
+    il_liheap_income_eligible: true  # 28k < 60% of 50k (30k)
+    il_liheap_eligible: false  # Rent (7k) <= 30% of income (8.4k)
+    il_liheap: 0
+
+- name: High income household not eligible
+  period: 2024
+  input:
+    people:
+      adult1:
+        age: 45
+        employment_income: 50_000
+        irs_gross_income: 50_000
+        rent: 24_000
+        heating_expense_person: 1_250  # Half of family heating costs
+      adult2:
+        age: 43
+        employment_income: 45_000
+        irs_gross_income: 45_000
+        heating_expense_person: 1_250  # Half of family heating costs
+    tax_units:
+      tax_unit:
+        members: [adult1, adult2]
+    spm_units:
+      spm_unit:
+        members: [adult1, adult2]
+        heat_expense_included_in_rent: false
+    households:
+      household:
+        members: [adult1, adult2]
+        state_code: IL
+  output:
+    il_liheap_income_eligible: false  # 95k > 60% of 70k (42k) and > 200% of 20.4k (40.8k)
+    il_liheap_eligible: false
+    il_liheap: 0

policyengine_us/tests/policy/baseline/gov/states/il/dceo/liheap/payment/il_liheap_base_payment.yaml

@@ -0,0 +1,83 @@
+- name: Heat not included in rent - benefit based on heating expenses
+  period: 2024
+  input:
+    people:
+      person:
+        age: 30
+        heating_expense_person: 1_000
+    tax_units:
+      tax_unit:
+        members: [person]
+    spm_units:
+      spm_unit:
+        members: [person]
+        heat_expense_included_in_rent: false
+    households:
+      household:
+        members: [person]
+        state_code: IL
+  output:
+    il_liheap_base_payment: 1_000  # Heating expenses within range
+
+- name: Heat not included in rent - expenses exceed maximum
+  period: 2024
+  input:
+    people:
+      person:
+        age: 30
+        heating_expense_person: 3_000
+    tax_units:
+      tax_unit:
+        members: [person]
+    spm_units:
+      spm_unit:
+        members: [person]
+        heat_expense_included_in_rent: false
+    households:
+      household:
+        members: [person]
+        state_code: IL
+  output:
+    il_liheap_base_payment: 2_075  # Capped at maximum
+
+- name: Heat included in rent - minimum cash benefit
+  period: 2024
+  input:
+    people:
+      person:
+        age: 30
+        heating_expense_person: 500  # Irrelevant when heat included
+    tax_units:
+      tax_unit:
+        members: [person]
+    spm_units:
+      spm_unit:
+        members: [person]
+        heat_expense_included_in_rent: true
+    households:
+      household:
+        members: [person]
+        state_code: IL
+  output:
+    il_liheap_base_payment: 315  # Fixed minimum for heat included in rent
+
+- name: Heat not included in rent - low heating expenses get actual amount
+  period: 2024
+  input:
+    people:
+      person:
+        age: 30
+        heating_expense_person: 200
+    tax_units:
+      tax_unit:
+        members: [person]
+    spm_units:
+      spm_unit:
+        members: [person]
+        heat_expense_included_in_rent: false
+    households:
+      household:
+        members: [person]
+        state_code: IL
+  output:
+    il_liheap_base_payment: 200  # Gets actual heating expenses

policyengine_us/variables/gov/local/ca/riv/general_relief/ca_riv_general_relief.py

@@ -0,0 +1,16 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief(Variable):
+    value_type = float
+    entity = SPMUnit
+    unit = USD
+    label = "Riverside County General Relief"
+    definition_period = MONTH
+    defined_for = "ca_riv_general_relief_eligible"
+
+    adds = [
+        "ca_riv_general_relief_needs_standards",
+        "ca_riv_general_relief_special_needs_amount",
+    ]
+    subtracts = ["ca_riv_general_relief_countable_income"]

policyengine_us/variables/gov/local/ca/riv/general_relief/ca_riv_general_relief_budget_unit_size.py

@@ -0,0 +1,14 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_budget_unit_size(Variable):
+    value_type = int
+    entity = SPMUnit
+    label = "Riverside County General Relief budget unit size"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    # Ineligible persons in the SPM Unit cannot receive GR benefits.
+    # The number of ineligible person would never exceed the number of people in the SPM Unit.
+    adds = ["spm_unit_size"]
+    subtracts = ["ca_riv_general_relief_ineligible_person"]

policyengine_us/variables/gov/local/ca/riv/general_relief/eligibility/ca_riv_general_relief_eligible.py

@@ -0,0 +1,47 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_eligible(Variable):
+    value_type = bool
+    entity = SPMUnit
+    label = "Eligible for the Riverside County General Relief"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    def formula(spm_unit, period, parameters):
+        p = parameters(period).gov.local.ca.riv.general_relief
+        age = spm_unit.members("monthly_age", period)
+        # Adults with dependent children under certain age are NOT eligible for GA.
+        # They should apply for CalWORKs (California's TANF) instead.
+        age_eligible = spm_unit.all(age >= p.age_threshold)
+
+        immigration_status_eligible = (
+            add(
+                spm_unit,
+                period,
+                ["ca_riv_general_relief_immigration_status_eligible"],
+            )
+            > 0
+        )
+        meets_work_requirements = (
+            add(
+                spm_unit,
+                period,
+                ["ca_riv_general_relief_meets_work_requirements"],
+            )
+            > 0
+        )
+        property_eligible = spm_unit(
+            "ca_riv_general_relief_property_eligible", period
+        )
+        income_eligible = spm_unit(
+            "ca_riv_general_relief_income_eligible", period
+        )
+
+        return (
+            age_eligible
+            & immigration_status_eligible
+            & property_eligible
+            & income_eligible
+            & meets_work_requirements
+        )

policyengine_us/variables/gov/local/ca/riv/general_relief/eligibility/ca_riv_general_relief_immigration_status_eligible.py

@@ -0,0 +1,15 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_immigration_status_eligible(Variable):
+    value_type = bool
+    entity = Person
+    label = "Eligible for the Riverside County General Relief due to immigration status"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    def formula(person, period, parameters):
+        p = parameters(period).gov.local.ca.riv.general_relief
+        immigration_status = person("immigration_status", period)
+        immigration_status_str = immigration_status.decode_to_str()
+        return np.isin(immigration_status_str, p.qualified_immigration_status)

policyengine_us/variables/gov/local/ca/riv/general_relief/eligibility/ca_riv_general_relief_income_eligible.py

@@ -0,0 +1,18 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_income_eligible(Variable):
+    value_type = bool
+    entity = SPMUnit
+    label = "Eligible for the Riverside County General Relief due to income"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    def formula(spm_unit, period, parameters):
+        countable_income = spm_unit(
+            "ca_riv_general_relief_countable_income", period
+        )
+        needs_standards = spm_unit(
+            "ca_riv_general_relief_needs_standards", period
+        )
+        return countable_income <= needs_standards

policyengine_us/variables/gov/local/ca/riv/general_relief/eligibility/ca_riv_general_relief_ineligible_person.py

@@ -0,0 +1,25 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_ineligible_person(Variable):
+    value_type = bool
+    entity = Person
+    label = "Ineligible person for the Riverside County General Relief"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    def formula(person, period, parameters):
+        receives_ssi_or_tanf = (
+            add(person.spm_unit, period, ["ssi", "ca_tanf"]) > 0
+        )
+        immigration_status_eligible = person(
+            "ca_riv_general_relief_immigration_status_eligible", period
+        )
+        meets_work_requirement = person(
+            "ca_riv_general_relief_meets_work_requirements", period
+        )
+        return (
+            receives_ssi_or_tanf
+            | ~immigration_status_eligible
+            | ~meets_work_requirement
+        )

policyengine_us/variables/gov/local/ca/riv/general_relief/eligibility/ca_riv_general_relief_meets_work_requirements.py

@@ -0,0 +1,43 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_meets_work_requirements(Variable):
+    value_type = bool
+    entity = Person
+    label = "Meets work requirements for the Riverside County General Relief"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    def formula(person, period, parameters):
+        p = parameters(
+            period
+        ).gov.local.ca.riv.general_relief.work_exempted_age
+        # Person who is actively searching for jobs also qualify for work requirements
+        is_working = (
+            add(
+                person, period, ["employment_income", "self_employment_income"]
+            )
+            > 0
+        )
+        # Check if person is a qualifying secondary school student
+        age = person("monthly_age", period)
+        is_full_time_student = person("is_full_time_student", period)
+        in_secondary_school = person("is_in_secondary_school", period)
+        is_qualifying_secondary_student = (
+            is_full_time_student & in_secondary_school
+        )
+        # Age-based exemptions have different thresholds based on student status:
+        # - Full-time secondary students: exempt if younger than threshold
+        # - Non-students: exempt if older than threshold (senior citizens)
+        work_exempted_due_to_age = where(
+            is_qualifying_secondary_student,
+            age < p.younger,  # Student exemption: too young
+            age >= p.older,  # Senior exemption: too old
+        )
+        # Incapacitated or need to caring full time for a member of household
+        has_incapable_of_self_care = person.spm_unit.any(
+            person("is_incapable_of_self_care", period)
+        )
+        return (
+            is_working | work_exempted_due_to_age | has_incapable_of_self_care
+        )

policyengine_us/variables/gov/local/ca/riv/general_relief/eligibility/ca_riv_general_relief_property_eligible.py

@@ -0,0 +1,16 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_property_eligible(Variable):
+    value_type = bool
+    entity = SPMUnit
+    label = "Meets property limit for Riverside County General Relief"
+    definition_period = YEAR
+    defined_for = "in_riv"
+
+    def formula(spm_unit, period, parameters):
+        p = parameters(period).gov.local.ca.riv.general_relief.property
+        total_property_value = spm_unit(
+            "ca_riv_general_relief_countable_property_value", period
+        )
+        return total_property_value < p.limit

policyengine_us/variables/gov/local/ca/riv/general_relief/income/ca_riv_general_relief_countable_income.py

@@ -0,0 +1,16 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_countable_income(Variable):
+    value_type = float
+    entity = SPMUnit
+    unit = USD
+    label = "Riverside County General Relief countable income"
+    definition_period = MONTH
+    defined_for = "in_riv"
+
+    # This value cannot be negative because the exclusion is calculated
+    # as a fraction of the excluded person's income, determined by
+    # household size and the number of applicants.
+    adds = ["ca_riv_general_relief_countable_income_person"]
+    subtracts = ["ca_riv_general_relief_excluded_income"]

policyengine_us/variables/gov/local/ca/riv/general_relief/income/ca_riv_general_relief_countable_income_person.py

@@ -0,0 +1,14 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_countable_income_person(Variable):
+    value_type = float
+    entity = Person
+    unit = USD
+    label = "Person's countable income before proration"
+    definition_period = MONTH
+
+    adds = [
+        "ca_riv_general_relief_net_earned_income",
+        "ca_riv_general_relief_unearned_income",
+    ]

policyengine_us/variables/gov/local/ca/riv/general_relief/income/ca_riv_general_relief_excluded_income.py

@@ -0,0 +1,22 @@
+from policyengine_us.model_api import *
+
+
+class ca_riv_general_relief_excluded_income(Variable):
+    value_type = float
+    entity = Person
+    unit = USD
+    label = "Income amount excluded from ineligible household members due to proration under Riverside County General Relief Program"
+    definition_period = MONTH
+    defined_for = "ca_riv_general_relief_ineligible_person"
+
+    def formula(person, period, parameters):
+        income = person(
+            "ca_riv_general_relief_countable_income_person", period
+        )
+        spm_unit = person.spm_unit
+        needs_unit_size = spm_unit("spm_unit_size", period)
+        budget_unit_size = spm_unit(
+            "ca_riv_general_relief_budget_unit_size", period
+        )
+        exclusion_rate = (needs_unit_size - budget_unit_size) / needs_unit_size
+        return exclusion_rate * income