Repository navigation
A reform simulation's baseline reads the reform's default for people the situation gives no value #612
Description
Problem
Simulation(situation=..., reform=...) builds the situation under the reform's tax-benefit system, then makes its baseline as a branch of that simulation and gives the branch the baseline system. When the situation gives a variable for some people and not others (or sets it along axes), SimulationBuilder fills the other entries with that variable's default from the system it was given, the reform's, and stores the whole array as an input (add_variable_value and expand_axes start from variable.default_array(...); finalize_variables_init calls holder.set_input with the full array). The baseline branch inherits those inputs, so it reads the reform's default for people the situation never gave a value.
Reproduced on master b909d5a, from the repository root with uv run --frozen --extra dev python:
import sys; sys.path.insert(0, ".")
from policyengine_core.country_template import Simulation
from tests.core.test_reform_baseline_system import change_salary_default # salary default 0 -> 1000
P = "2022-01"
sit = {"persons": {"a": {"salary": {P: 3000.0}}, "b": {}}, "households": {"h": {"parents": ["a", "b"]}}}
s = Simulation(situation=sit, reform=change_salary_default)
print(s.baseline.calculate("salary", P)) # [3000. 1000.]
print(Simulation(situation=sit).calculate("salary", P)) # [3000. 0.]With axes ("axes": [[{"name": "salary", "count": 2, "min": 0, "max": 5000, "period": P}]] over two people with no salary), the baseline gives [0, 1000, 5000, 1000]; the same situation built under the baseline system gives [0, 0, 5000, 0].
The same inheritance loses an input the reform neutralizes. The reform's system ignores a situation's income_tax (it warns that the variable is neutralized), so the baseline branch has no input either and calculates it:
from tests.core.test_reform_baseline_system import neutralize_income_tax
sit = {"persons": {"a": {"salary": {P: 3000.0}, "income_tax": {P: 7.0}}}, "households": {"h": {"parents": ["a"]}}}
print(Simulation(situation=sit, reform=neutralize_income_tax).baseline.calculate("income_tax", P)) # [450.00003]
print(Simulation(situation=sit).calculate("income_tax", P)) # [7.]Simulation._bind_to_tax_benefit_system re-points the baseline's populations and holders at the baseline system's entities and variables, but the arrays it inherited were built by the reform's.
tests/core/test_reform_baseline_system.py::test_an_input_default_the_reform_changes_is_the_baselines_in_the_baseline notes the limitation in a comment and avoids it by giving no one a salary.
Expected
A reform simulation's baseline is what the builder makes from the situation under the baseline system: people the situation gives no value take the baseline system's default, and inputs the reform's system ignores are the baseline's.
Notes
- A stored input is all-or-nothing today:
Holder.set_input,_user_input_keys,StoreHistoryandto_input_dataframerecord and export whole arrays, andset_input_divide_by_period/set_input_dispatch_by_periodcombine a larger period's array with the sub-period inputs already stored. So the default given to one person at one period also changes what other periods' inputs are divided into. - policyengine-us reaches this through core's
Simulation.__init__. policyengine-uk builds its baseline as a separateSimulationfrom the situation, so it is not affected. - Related: Replace a simulation's population when the builder writes a situation into it #611 (the builder replaces a simulation's population) touches the same files.
Activity