-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhousehold.py
More file actions
1333 lines (1169 loc) · 45.8 KB
/
household.py
File metadata and controls
1333 lines (1169 loc) · 45.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Household calculation endpoints.
These endpoints are async - they create jobs that are processed by Modal functions.
Poll the status endpoint until the job is complete.
"""
import math
from typing import Any
from uuid import UUID
import logfire
from fastapi import APIRouter, Depends, HTTPException
from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
from pydantic import BaseModel, Field
from sqlmodel import Session
from policyengine_api.config.constants import CountryId
from policyengine_api.models import (
Dynamic,
HouseholdJob,
HouseholdJobStatus,
Policy,
)
from policyengine_api.services.database import get_session
def _sanitize_for_json(obj: Any) -> Any:
"""Replace NaN/Inf values with None for JSON serialization."""
if isinstance(obj, float):
if math.isnan(obj) or math.isinf(obj):
return None
return obj
elif isinstance(obj, dict):
return {k: _sanitize_for_json(v) for k, v in obj.items()}
elif isinstance(obj, list):
return [_sanitize_for_json(v) for v in obj]
return obj
def get_traceparent() -> str | None:
"""Get the current W3C traceparent header for distributed tracing."""
carrier: dict[str, str] = {}
TraceContextTextMapPropagator().inject(carrier)
return carrier.get("traceparent")
router = APIRouter(prefix="/household", tags=["household"])
class AxisSpec(BaseModel):
"""Specification for a single axis in an axes group."""
name: str = Field(description="Variable name to vary, e.g. 'employment_income'")
min: float = Field(description="Minimum value of the range")
max: float = Field(description="Maximum value of the range")
count: int = Field(description="Number of evenly-spaced steps (e.g. 401)")
index: int = Field(
default=0, description="Which person (by index) to vary. Default 0."
)
class HouseholdCalculateRequest(BaseModel):
"""Request body for household calculation.
IMPORTANT: Use flat values for variables, NOT time-period dictionaries.
The year is specified separately via the `year` parameter.
CORRECT: {"employment_income": 70000, "age": 40}
WRONG: {"employment_income": {"2024": 70000}, "age": {"2024": 40}}
Supports multiple households via entity relational dataframes. Include
{entity}_id fields in each entity and person_{entity}_id fields in people
to link them together.
Example US request (single household, simple):
{
"country_id": "us",
"people": [{"employment_income": 70000, "age": 40}],
"tax_unit": [{"state_code": "CA"}],
"household": [{"state_fips": 6}],
"year": 2024
}
Example US request (multiple households):
{
"country_id": "us",
"people": [
{"person_id": 0, "person_household_id": 0, "person_tax_unit_id": 0, "age": 40, "employment_income": 70000},
{"person_id": 1, "person_household_id": 1, "person_tax_unit_id": 1, "age": 30, "employment_income": 50000}
],
"tax_unit": [
{"tax_unit_id": 0, "state_code": "CA"},
{"tax_unit_id": 1, "state_code": "NY"}
],
"household": [
{"household_id": 0, "state_fips": 6},
{"household_id": 1, "state_fips": 36}
],
"year": 2024
}
Example UK request:
{
"country_id": "uk",
"people": [{"employment_income": 50000, "age": 30}],
"household": [{}],
"year": 2026
}
"""
country_id: CountryId = Field(
description="Which country model to use ('us' or 'uk')"
)
people: list[dict[str, Any]] = Field(
description="List of people with flat variable values. Include person_id and person_{entity}_id fields to link to entities."
)
benunit: list[dict[str, Any]] = Field(
default_factory=list,
description="UK benefit units. Include benunit_id to link with person_benunit_id in people.",
)
marital_unit: list[dict[str, Any]] = Field(
default_factory=list,
description="US marital units. Include marital_unit_id to link with person_marital_unit_id in people.",
)
family: list[dict[str, Any]] = Field(
default_factory=list,
description="US families. Include family_id to link with person_family_id in people.",
)
spm_unit: list[dict[str, Any]] = Field(
default_factory=list,
description="US SPM units. Include spm_unit_id to link with person_spm_unit_id in people.",
)
tax_unit: list[dict[str, Any]] = Field(
default_factory=list,
description="US tax units. Include tax_unit_id to link with person_tax_unit_id in people.",
)
household: list[dict[str, Any]] = Field(
default_factory=list,
description="Households. Include household_id to link with person_household_id in people.",
)
year: int | None = Field(
default=None,
description="Simulation year (default: 2024 for US, 2026 for UK). Specify this instead of embedding years in variable values.",
)
policy_id: UUID | None = Field(
default=None, description="Optional policy reform ID"
)
dynamic_id: UUID | None = Field(
default=None, description="Optional behavioural response ID"
)
axes: list[list[AxisSpec]] | None = Field(
default=None,
description="Optional axes for earnings variation. List of axis groups; each group is a list of parallel axes.",
)
class HouseholdCalculateResponse(BaseModel):
"""Response from household calculation."""
person: list[dict[str, Any]]
benunit: list[dict[str, Any]] | None = None
marital_unit: list[dict[str, Any]] | None = None
family: list[dict[str, Any]] | None = None
spm_unit: list[dict[str, Any]] | None = None
tax_unit: list[dict[str, Any]] | None = None
household: list[dict[str, Any]]
class HouseholdJobResponse(BaseModel):
"""Response from creating a household job."""
job_id: UUID
status: HouseholdJobStatus
class HouseholdJobStatusResponse(BaseModel):
"""Response from polling a household job."""
job_id: UUID
status: HouseholdJobStatus
result: HouseholdCalculateResponse | None = None
error_message: str | None = None
class HouseholdImpactRequest(BaseModel):
"""Request body for household impact comparison.
Same format as HouseholdCalculateRequest - use flat values, NOT time-period dictionaries.
Supports multiple households via entity relational dataframes.
Example:
{
"country_id": "us",
"people": [{"employment_income": 70000, "age": 40}],
"tax_unit": [{"state_code": "CA"}],
"household": [{"state_fips": 6}],
"year": 2024,
"policy_id": "uuid-of-reform-policy"
}
"""
country_id: CountryId = Field(
description="Which country model to use ('us' or 'uk')"
)
people: list[dict[str, Any]] = Field(
description="List of people with flat variable values. Include person_id and person_{entity}_id fields to link to entities."
)
benunit: list[dict[str, Any]] = Field(
default_factory=list,
description="UK benefit units. Include benunit_id to link with person_benunit_id in people.",
)
marital_unit: list[dict[str, Any]] = Field(
default_factory=list,
description="US marital units. Include marital_unit_id to link with person_marital_unit_id in people.",
)
family: list[dict[str, Any]] = Field(
default_factory=list,
description="US families. Include family_id to link with person_family_id in people.",
)
spm_unit: list[dict[str, Any]] = Field(
default_factory=list,
description="US SPM units. Include spm_unit_id to link with person_spm_unit_id in people.",
)
tax_unit: list[dict[str, Any]] = Field(
default_factory=list,
description="US tax units. Include tax_unit_id to link with person_tax_unit_id in people.",
)
household: list[dict[str, Any]] = Field(
default_factory=list,
description="Households. Include household_id to link with person_household_id in people.",
)
year: int | None = Field(
default=None, description="Simulation year (default: 2024 for US, 2026 for UK)"
)
policy_id: UUID | None = Field(
default=None, description="Reform policy ID to compare against baseline"
)
dynamic_id: UUID | None = Field(
default=None, description="Optional behavioural response ID"
)
class HouseholdImpactResponse(BaseModel):
"""Response from household impact comparison."""
baseline: HouseholdCalculateResponse
reform: HouseholdCalculateResponse
impact: dict[str, Any] # Computed differences
class HouseholdImpactJobStatusResponse(BaseModel):
"""Response from polling a household impact job."""
job_id: UUID
status: HouseholdJobStatus
baseline_result: HouseholdCalculateResponse | None = None
reform_result: HouseholdCalculateResponse | None = None
impact: dict[str, Any] | None = None
error_message: str | None = None
def _run_local_household_uk(
job_id: str,
people: list[dict],
benunit: list[dict],
household: list[dict],
year: int,
policy_data: dict | None,
session: Session,
axes: list[list[dict]] | None = None,
) -> None:
"""Run UK household calculation locally.
Supports multiple households via entity relational dataframes.
"""
from datetime import datetime, timezone
try:
result = _calculate_household_uk(
people, benunit, household, year, policy_data, axes=axes
)
# Update job with result
job = session.get(HouseholdJob, job_id)
if job:
job.status = HouseholdJobStatus.COMPLETED
job.result = _sanitize_for_json(result)
job.completed_at = datetime.now(timezone.utc)
session.add(job)
session.commit()
except Exception as e:
from datetime import datetime, timezone
# Update job with error
job = session.get(HouseholdJob, job_id)
if job:
job.status = HouseholdJobStatus.FAILED
job.error_message = str(e)
job.completed_at = datetime.now(timezone.utc)
session.add(job)
session.commit()
raise
def _calculate_household_uk(
people: list[dict],
benunit: list[dict],
household: list[dict],
year: int,
policy_data: dict | None,
axes: list[list[dict]] | None = None,
) -> dict:
"""Calculate UK household(s) and return result dict.
Supports multiple households via entity relational dataframes. If entity IDs
are not provided, defaults to single household with all people in it.
"""
import tempfile
from datetime import datetime
from pathlib import Path
import pandas as pd
from microdf import MicroDataFrame
from policyengine.core import Simulation
from policyengine.tax_benefit_models.uk import uk_latest
from policyengine.tax_benefit_models.uk.datasets import (
PolicyEngineUKDataset,
UKYearData,
)
n_people = len(people)
n_benunits = max(1, len(benunit))
n_households = max(1, len(household))
# Build person data with defaults
person_data = {
"person_id": list(range(n_people)),
"person_benunit_id": [0] * n_people,
"person_household_id": [0] * n_people,
"person_weight": [1.0] * n_people,
}
# Add user-provided person fields
for i, person in enumerate(people):
for key, value in person.items():
if key not in person_data:
person_data[key] = [0.0] * n_people
person_data[key][i] = value
# Build benunit data with defaults
benunit_data = {
"benunit_id": list(range(n_benunits)),
"benunit_weight": [1.0] * n_benunits,
}
for i, bu in enumerate(benunit if benunit else [{}]):
for key, value in bu.items():
if key not in benunit_data:
benunit_data[key] = [0.0] * n_benunits
benunit_data[key][i] = value
# Build household data with defaults
household_data = {
"household_id": list(range(n_households)),
"household_weight": [1.0] * n_households,
"region": ["LONDON"] * n_households,
"tenure_type": ["RENT_PRIVATELY"] * n_households,
"council_tax": [0.0] * n_households,
"rent": [0.0] * n_households,
}
for i, hh in enumerate(household if household else [{}]):
for key, value in hh.items():
if key not in household_data:
household_data[key] = [0.0] * n_households
household_data[key][i] = value
# Save original counts for axes reshape
n_original_people = n_people
n_original_benunits = n_benunits
n_original_households = n_households
axis_count = 0
# Expand data for axes if provided
if axes is not None:
from policyengine_api.utils.axes import expand_dataframes_for_axes
entity_datas = {"benunit": benunit_data, "household": household_data}
person_entity_id_keys = {
"benunit": "person_benunit_id",
"household": "person_household_id",
}
person_data, expanded_entities, axis_count = expand_dataframes_for_axes(
axes, person_data, entity_datas, person_entity_id_keys
)
benunit_data = expanded_entities["benunit"]
household_data = expanded_entities["household"]
n_people = len(person_data["person_id"])
n_benunits = len(benunit_data["benunit_id"])
n_households = len(household_data["household_id"])
# Create MicroDataFrames
person_df = MicroDataFrame(pd.DataFrame(person_data), weights="person_weight")
benunit_df = MicroDataFrame(pd.DataFrame(benunit_data), weights="benunit_weight")
household_df = MicroDataFrame(
pd.DataFrame(household_data), weights="household_weight"
)
# Create temporary dataset
tmpdir = tempfile.mkdtemp()
filepath = str(Path(tmpdir) / "household_calc.h5")
dataset = PolicyEngineUKDataset(
name="Household calculation",
description="Household(s) for calculation",
filepath=filepath,
year=year,
data=UKYearData(
person=person_df,
benunit=benunit_df,
household=household_df,
),
)
# Build policy if provided
policy = None
if policy_data:
from policyengine.core.policy import ParameterValue as PEParameterValue
from policyengine.core.policy import Policy as PEPolicy
pe_param_values = []
param_lookup = {p.name: p for p in uk_latest.parameters}
for pv in policy_data.get("parameter_values", []):
pe_param = param_lookup.get(pv["parameter_name"])
if pe_param:
pe_pv = PEParameterValue(
parameter=pe_param,
value=pv["value"],
start_date=datetime.fromisoformat(pv["start_date"])
if pv.get("start_date")
else None,
end_date=datetime.fromisoformat(pv["end_date"])
if pv.get("end_date")
else None,
)
pe_param_values.append(pe_pv)
policy = PEPolicy(
name=policy_data.get("name", ""),
description=policy_data.get("description", ""),
parameter_values=pe_param_values,
)
# Run simulation
simulation = Simulation(
dataset=dataset,
tax_benefit_model_version=uk_latest,
policy=policy,
)
simulation.run()
# Extract outputs
output_data = simulation.output_dataset.data
def safe_convert(value):
try:
return float(value)
except (ValueError, TypeError):
return str(value)
person_outputs = []
for i in range(n_people):
person_dict = {}
for var in uk_latest.entity_variables["person"]:
person_dict[var] = safe_convert(output_data.person[var].iloc[i])
person_outputs.append(person_dict)
benunit_outputs = []
for i in range(len(output_data.benunit)):
benunit_dict = {}
for var in uk_latest.entity_variables["benunit"]:
benunit_dict[var] = safe_convert(output_data.benunit[var].iloc[i])
benunit_outputs.append(benunit_dict)
household_outputs = []
for i in range(len(output_data.household)):
household_dict = {}
for var in uk_latest.entity_variables["household"]:
household_dict[var] = safe_convert(output_data.household[var].iloc[i])
household_outputs.append(household_dict)
result = {
"person": person_outputs,
"benunit": benunit_outputs,
"household": household_outputs,
}
# Reshape output for axes
if axes is not None:
from policyengine_api.utils.axes import reshape_axes_output
n_original = {
"person": n_original_people,
"benunit": n_original_benunits,
"household": n_original_households,
}
result = reshape_axes_output(result, n_original, axis_count)
return result
def _run_local_household_us(
job_id: str,
people: list[dict],
marital_unit: list[dict],
family: list[dict],
spm_unit: list[dict],
tax_unit: list[dict],
household: list[dict],
year: int,
policy_data: dict | None,
session: Session,
axes: list[list[dict]] | None = None,
) -> None:
"""Run US household calculation locally.
Supports multiple households via entity relational dataframes.
"""
from datetime import datetime, timezone
try:
result = _calculate_household_us(
people,
marital_unit,
family,
spm_unit,
tax_unit,
household,
year,
policy_data,
axes=axes,
)
# Update job with result
job = session.get(HouseholdJob, job_id)
if job:
job.status = HouseholdJobStatus.COMPLETED
job.result = _sanitize_for_json(result)
job.completed_at = datetime.now(timezone.utc)
session.add(job)
session.commit()
except Exception as e:
from datetime import datetime, timezone
# Update job with error
job = session.get(HouseholdJob, job_id)
if job:
job.status = HouseholdJobStatus.FAILED
job.error_message = str(e)
job.completed_at = datetime.now(timezone.utc)
session.add(job)
session.commit()
raise
def _calculate_household_us(
people: list[dict],
marital_unit: list[dict],
family: list[dict],
spm_unit: list[dict],
tax_unit: list[dict],
household: list[dict],
year: int,
policy_data: dict | None,
axes: list[list[dict]] | None = None,
) -> dict:
"""Calculate US household(s) and return result dict.
Supports multiple households via entity relational dataframes. If entity IDs
are not provided, defaults to single household with all people in it.
"""
import tempfile
from datetime import datetime
from pathlib import Path
import pandas as pd
from microdf import MicroDataFrame
from policyengine.core import Simulation
from policyengine.tax_benefit_models.us import us_latest
from policyengine.tax_benefit_models.us.datasets import (
PolicyEngineUSDataset,
USYearData,
)
n_people = len(people)
n_households = max(1, len(household))
n_marital_units = max(1, len(marital_unit))
n_families = max(1, len(family))
n_spm_units = max(1, len(spm_unit))
n_tax_units = max(1, len(tax_unit))
# Build person data with defaults
person_data = {
"person_id": list(range(n_people)),
"person_household_id": [0] * n_people,
"person_marital_unit_id": [0] * n_people,
"person_family_id": [0] * n_people,
"person_spm_unit_id": [0] * n_people,
"person_tax_unit_id": [0] * n_people,
"person_weight": [1.0] * n_people,
}
for i, person in enumerate(people):
for key, value in person.items():
if key not in person_data:
person_data[key] = [0.0] * n_people
person_data[key][i] = value
# Build household data
household_data = {
"household_id": list(range(n_households)),
"household_weight": [1.0] * n_households,
}
for i, hh in enumerate(household if household else [{}]):
for key, value in hh.items():
if key not in household_data:
household_data[key] = [0.0] * n_households
household_data[key][i] = value
# Build marital_unit data
marital_unit_data = {
"marital_unit_id": list(range(n_marital_units)),
"marital_unit_weight": [1.0] * n_marital_units,
}
for i, mu in enumerate(marital_unit if marital_unit else [{}]):
for key, value in mu.items():
if key not in marital_unit_data:
marital_unit_data[key] = [0.0] * n_marital_units
marital_unit_data[key][i] = value
# Build family data
family_data = {
"family_id": list(range(n_families)),
"family_weight": [1.0] * n_families,
}
for i, fam in enumerate(family if family else [{}]):
for key, value in fam.items():
if key not in family_data:
family_data[key] = [0.0] * n_families
family_data[key][i] = value
# Build spm_unit data
spm_unit_data = {
"spm_unit_id": list(range(n_spm_units)),
"spm_unit_weight": [1.0] * n_spm_units,
}
for i, spm in enumerate(spm_unit if spm_unit else [{}]):
for key, value in spm.items():
if key not in spm_unit_data:
spm_unit_data[key] = [0.0] * n_spm_units
spm_unit_data[key][i] = value
# Build tax_unit data
tax_unit_data = {
"tax_unit_id": list(range(n_tax_units)),
"tax_unit_weight": [1.0] * n_tax_units,
}
for i, tu in enumerate(tax_unit if tax_unit else [{}]):
for key, value in tu.items():
if key not in tax_unit_data:
tax_unit_data[key] = [0.0] * n_tax_units
tax_unit_data[key][i] = value
# Save original counts for axes reshape
n_original_people = n_people
n_original_households = n_households
n_original_marital_units = n_marital_units
n_original_families = n_families
n_original_spm_units = n_spm_units
n_original_tax_units = n_tax_units
axis_count = 0
# Expand data for axes if provided
if axes is not None:
from policyengine_api.utils.axes import expand_dataframes_for_axes
entity_datas = {
"household": household_data,
"marital_unit": marital_unit_data,
"family": family_data,
"spm_unit": spm_unit_data,
"tax_unit": tax_unit_data,
}
person_entity_id_keys = {
"household": "person_household_id",
"marital_unit": "person_marital_unit_id",
"family": "person_family_id",
"spm_unit": "person_spm_unit_id",
"tax_unit": "person_tax_unit_id",
}
person_data, expanded_entities, axis_count = expand_dataframes_for_axes(
axes, person_data, entity_datas, person_entity_id_keys
)
household_data = expanded_entities["household"]
marital_unit_data = expanded_entities["marital_unit"]
family_data = expanded_entities["family"]
spm_unit_data = expanded_entities["spm_unit"]
tax_unit_data = expanded_entities["tax_unit"]
n_people = len(person_data["person_id"])
n_households = len(household_data["household_id"])
n_marital_units = len(marital_unit_data["marital_unit_id"])
n_families = len(family_data["family_id"])
n_spm_units = len(spm_unit_data["spm_unit_id"])
n_tax_units = len(tax_unit_data["tax_unit_id"])
# Create MicroDataFrames
person_df = MicroDataFrame(pd.DataFrame(person_data), weights="person_weight")
household_df = MicroDataFrame(
pd.DataFrame(household_data), weights="household_weight"
)
marital_unit_df = MicroDataFrame(
pd.DataFrame(marital_unit_data), weights="marital_unit_weight"
)
family_df = MicroDataFrame(pd.DataFrame(family_data), weights="family_weight")
spm_unit_df = MicroDataFrame(pd.DataFrame(spm_unit_data), weights="spm_unit_weight")
tax_unit_df = MicroDataFrame(pd.DataFrame(tax_unit_data), weights="tax_unit_weight")
# Create temporary dataset
tmpdir = tempfile.mkdtemp()
filepath = str(Path(tmpdir) / "household_calc.h5")
dataset = PolicyEngineUSDataset(
name="Household calculation",
description="Household(s) for calculation",
filepath=filepath,
year=year,
data=USYearData(
person=person_df,
household=household_df,
marital_unit=marital_unit_df,
family=family_df,
spm_unit=spm_unit_df,
tax_unit=tax_unit_df,
),
)
# Build policy if provided
policy = None
if policy_data:
from policyengine.core.policy import ParameterValue as PEParameterValue
from policyengine.core.policy import Policy as PEPolicy
pe_param_values = []
param_lookup = {p.name: p for p in us_latest.parameters}
for pv in policy_data.get("parameter_values", []):
pe_param = param_lookup.get(pv["parameter_name"])
if pe_param:
pe_pv = PEParameterValue(
parameter=pe_param,
value=pv["value"],
start_date=datetime.fromisoformat(pv["start_date"])
if pv.get("start_date")
else None,
end_date=datetime.fromisoformat(pv["end_date"])
if pv.get("end_date")
else None,
)
pe_param_values.append(pe_pv)
policy = PEPolicy(
name=policy_data.get("name", ""),
description=policy_data.get("description", ""),
parameter_values=pe_param_values,
)
# Run simulation
simulation = Simulation(
dataset=dataset,
tax_benefit_model_version=us_latest,
policy=policy,
)
simulation.run()
# Extract outputs
output_data = simulation.output_dataset.data
def safe_convert(value):
try:
return float(value)
except (ValueError, TypeError):
return str(value)
def extract_entity_outputs(
entity_name: str, entity_data, n_rows: int
) -> list[dict]:
outputs = []
for i in range(n_rows):
row_dict = {}
for var in us_latest.entity_variables[entity_name]:
row_dict[var] = safe_convert(entity_data[var].iloc[i])
outputs.append(row_dict)
return outputs
result = {
"person": extract_entity_outputs("person", output_data.person, n_people),
"marital_unit": extract_entity_outputs(
"marital_unit", output_data.marital_unit, len(output_data.marital_unit)
),
"family": extract_entity_outputs(
"family", output_data.family, len(output_data.family)
),
"spm_unit": extract_entity_outputs(
"spm_unit", output_data.spm_unit, len(output_data.spm_unit)
),
"tax_unit": extract_entity_outputs(
"tax_unit", output_data.tax_unit, len(output_data.tax_unit)
),
"household": extract_entity_outputs(
"household", output_data.household, len(output_data.household)
),
}
# Reshape output for axes
if axes is not None:
from policyengine_api.utils.axes import reshape_axes_output
n_original = {
"person": n_original_people,
"household": n_original_households,
"marital_unit": n_original_marital_units,
"family": n_original_families,
"spm_unit": n_original_spm_units,
"tax_unit": n_original_tax_units,
}
result = reshape_axes_output(result, n_original, axis_count)
return result
def _trigger_modal_household(
job_id: str,
request: HouseholdCalculateRequest,
policy_data: dict | None,
dynamic_data: dict | None,
session: Session | None = None,
) -> None:
"""Trigger household simulation - Modal or local based on settings."""
from policyengine_api.config import settings
# Serialize axes to dicts for passing to Modal/local functions
axes_dicts: list[list[dict]] | None = None
if request.axes is not None:
axes_dicts = [[axis.model_dump() for axis in group] for group in request.axes]
if not settings.agent_use_modal and session is not None:
# Run locally
if request.country_id == "uk":
_run_local_household_uk(
job_id=job_id,
people=request.people,
benunit=request.benunit,
household=request.household,
year=request.year or 2026,
policy_data=policy_data,
session=session,
axes=axes_dicts,
)
else:
_run_local_household_us(
job_id=job_id,
people=request.people,
marital_unit=request.marital_unit,
family=request.family,
spm_unit=request.spm_unit,
tax_unit=request.tax_unit,
household=request.household,
year=request.year or 2024,
policy_data=policy_data,
session=session,
axes=axes_dicts,
)
else:
# Use Modal
import modal
traceparent = get_traceparent()
if request.country_id == "uk":
fn = modal.Function.from_name(
"policyengine",
"simulate_household_uk",
environment_name=settings.modal_environment,
)
fn.spawn(
job_id=job_id,
people=request.people,
benunit=request.benunit,
household=request.household,
year=request.year or 2026,
policy_data=policy_data,
dynamic_data=dynamic_data,
traceparent=traceparent,
axes=axes_dicts,
)
else:
fn = modal.Function.from_name(
"policyengine",
"simulate_household_us",
environment_name=settings.modal_environment,
)
fn.spawn(
job_id=job_id,
people=request.people,
marital_unit=request.marital_unit,
family=request.family,
spm_unit=request.spm_unit,
tax_unit=request.tax_unit,
household=request.household,
year=request.year or 2024,
policy_data=policy_data,
dynamic_data=dynamic_data,
traceparent=traceparent,
axes=axes_dicts,
)
def _get_policy_data(policy_id: UUID | None, session: Session) -> dict | None:
"""Get policy data for Modal function."""
if policy_id is None:
return None
db_policy = session.get(Policy, policy_id)
if not db_policy:
raise HTTPException(status_code=404, detail=f"Policy {policy_id} not found")
return {
"name": db_policy.name,
"description": db_policy.description,
"parameter_values": [
{
"parameter_name": pv.parameter.name if pv.parameter else None,
"value": pv.value_json.get("value")
if isinstance(pv.value_json, dict)
else pv.value_json,
"start_date": pv.start_date.isoformat() if pv.start_date else None,
"end_date": pv.end_date.isoformat() if pv.end_date else None,
}
for pv in db_policy.parameter_values
if pv.parameter
],
}
def _get_dynamic_data(dynamic_id: UUID | None, session: Session) -> dict | None:
"""Get dynamic data for Modal function."""
if dynamic_id is None:
return None
db_dynamic = session.get(Dynamic, dynamic_id)
if not db_dynamic:
raise HTTPException(status_code=404, detail=f"Dynamic {dynamic_id} not found")
return {
"name": db_dynamic.name,
"description": db_dynamic.description,
"parameter_values": [
{
"parameter_name": pv.parameter.name if pv.parameter else None,
"value": pv.value_json.get("value")
if isinstance(pv.value_json, dict)
else pv.value_json,
"start_date": pv.start_date.isoformat() if pv.start_date else None,
"end_date": pv.end_date.isoformat() if pv.end_date else None,
}
for pv in db_dynamic.parameter_values
if pv.parameter
],
}
@router.post("/calculate", response_model=HouseholdJobResponse)
def calculate_household(
request: HouseholdCalculateRequest,
session: Session = Depends(get_session),
) -> HouseholdJobResponse:
"""Create a household calculation job.
This is an async operation. The endpoint returns immediately with a job_id.
Poll GET /household/calculate/{job_id} until status is "completed" to get results.
Use flat values for all variables - do NOT use time-period format like {"2024": value}.
The simulation year is specified via the `year` parameter.
US example: people=[{"employment_income": 70000, "age": 40}], tax_unit={"state_code": "CA"}, year=2024
UK example: people=[{"employment_income": 50000, "age": 30}], year=2026
"""
with logfire.span(
"create_household_job",
model=request.country_id,
num_people=len(request.people),
year=request.year,
has_policy=request.policy_id is not None,
has_dynamic=request.dynamic_id is not None,
):