policyengine 3.1.4__py3-none-any.whl → 3.1.6__py3-none-any.whl

policyengine/core/dataset.py

@@ -1,5 +1,6 @@
 from uuid import uuid4
 
+import numpy as np
 import pandas as pd
 from microdf import MicroDataFrame
 from pydantic import BaseModel, ConfigDict, Field
@@ -100,7 +101,7 @@ def map_to_entity(
     target_entity: str,
     person_entity: str = "person",
     columns: list[str] | None = None,
-    values: list | None = None,
+    values: np.ndarray | None = None,
     how: str = "sum",
 ) -> MicroDataFrame:
     """Map data from source entity to target entity using join keys.
@@ -143,6 +144,9 @@ def map_to_entity(
     # Get source data (convert to plain DataFrame to avoid weighted operations during mapping)
     source_df = pd.DataFrame(entity_data[source_entity])
 
+    # Track if we should return a MicroSeries (values is a numpy array, not a list)
+    return_series = values is not None
+
     # Handle values parameter - create a temporary column with the provided values
     if values is not None:
         if len(values) != len(source_df):
@@ -166,7 +170,10 @@ def map_to_entity(
 
     # Same entity - return as is
     if source_entity == target_entity:
-        return MicroDataFrame(source_df, weights=target_weight)
+        result = MicroDataFrame(source_df, weights=target_weight)
+        if return_series:
+            return result["__mapped_value"]
+        return result
 
     # Get target data and key
     target_df = entity_data[target_entity]
@@ -225,7 +232,10 @@ def map_to_entity(
             # Fill NaN with 0 for groups with no members in source entity
             result[agg_cols] = result[agg_cols].fillna(0)
 
-            return MicroDataFrame(result, weights=target_weight)
+            result_df = MicroDataFrame(result, weights=target_weight)
+            if return_series:
+                return result_df["__mapped_value"]
+            return result_df
 
     # Group entity to person: expand group-level data to person level
     if source_entity != person_entity and target_entity == person_entity:
@@ -284,7 +294,10 @@ def map_to_entity(
                     f"Unsupported aggregation method for group->person: {how}. Use 'project' or 'divide'."
                 )
 
-            return MicroDataFrame(result, weights=target_weight)
+            result_df = MicroDataFrame(result, weights=target_weight)
+            if return_series:
+                return result_df["__mapped_value"]
+            return result_df
 
     # Group to group: go through person table
     if source_entity != person_entity and target_entity != person_entity:
@@ -408,7 +421,10 @@ def map_to_entity(
             # Fill NaN with 0
             result[agg_cols] = result[agg_cols].fillna(0)
 
-            return MicroDataFrame(result, weights=target_weight)
+            result_df = MicroDataFrame(result, weights=target_weight)
+            if return_series:
+                return result_df["__mapped_value"]
+            return result_df
 
     raise ValueError(
         f"Unsupported mapping from {source_entity} to {target_entity}"

policyengine/core/parameter.py

@@ -2,6 +2,7 @@ from uuid import uuid4
 
 from pydantic import BaseModel, Field
 
+from .parameter_value import ParameterValue
 from .tax_benefit_model_version import TaxBenefitModelVersion
 
 
@@ -13,3 +14,4 @@ class Parameter(BaseModel):
     data_type: type | None = None
     tax_benefit_model_version: TaxBenefitModelVersion
     unit: str | None = None
+    parameter_values: list["ParameterValue"] = Field(default_factory=list)

policyengine/tax_benefit_models/uk/model.py

@@ -177,6 +177,9 @@ class PolicyEngineUKLatest(TaxBenefitModelVersion):
                         value=param_at_instant.value,
                     )
                     self.parameter_values.append(parameter_value)
+                    self.get_parameter(parameter.name).parameter_values.append(
+                        parameter_value
+                    )
 
     def run(self, simulation: "Simulation") -> "Simulation":
         from policyengine_uk import Microsimulation

policyengine/tax_benefit_models/us/model.py

@@ -167,6 +167,9 @@ class PolicyEngineUSLatest(TaxBenefitModelVersion):
                         value=param_at_instant.value,
                     )
                     self.parameter_values.append(parameter_value)
+                    self.get_parameter(parameter.name).parameter_values.append(
+                        parameter_value
+                    )
 
     def run(self, simulation: "Simulation") -> "Simulation":
         from policyengine_us import Microsimulation

{policyengine-3.1.4.dist-info → policyengine-3.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: policyengine
-Version: 3.1.4
+Version: 3.1.6
 Summary: A package to conduct policy analysis using PolicyEngine tax-benefit models.
 Author-email: PolicyEngine <hello@policyengine.org>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE

{policyengine-3.1.4.dist-info → policyengine-3.1.6.dist-info}/RECORD

@@ -1,11 +1,11 @@
 policyengine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-policyengine/__pycache__/__init__.cpython-313.pyc,sha256=37QsU34QzZ56-bY7bRgKUcPPwi-onLZ481cHrbg3PDU,175
+policyengine/__pycache__/__init__.cpython-313.pyc,sha256=uYQXIlDDDMSRk17xgnGViCXX-MefhsWgf4kL0hHrVaQ,175
 policyengine/core/__init__.py,sha256=KBVhkqzkvjWLDDwk96vquQKL63ZFuLen5AzBOBnO9pg,912
-policyengine/core/dataset.py,sha256=SFicjsZgMeKgJjlt8z98fOUWG2dfod0Q9NBy_m9PSc8,15506
+policyengine/core/dataset.py,sha256=iJr9-J6w11uMRYy3EEJO9Gveku1m71AA1yzeo-0SiCs,16094
 policyengine/core/dataset_version.py,sha256=6KeFCRGQto_Yyl4QY4Vo2JFythjaXrNAOHQiwRGESyM,378
 policyengine/core/dynamic.py,sha256=ng9BjDzxdwjJ0e7zoqXFmq33E1SRbaaPYfW7pjRSSzI,1641
 policyengine/core/output.py,sha256=cCW4vbzkLdQaT_nJTyDJBl7Hubm7nZeRuR7aVG1dKvg,643
-policyengine/core/parameter.py,sha256=5nBCw-6-BCfW-_uFqvAN5zcP_Vfz1mAmQsi3peWAbZA,407
+policyengine/core/parameter.py,sha256=wePNpoeSEwI2NLE1gENKvS4pqWd-GpN8f8-iZzxNHlo,526
 policyengine/core/parameter_value.py,sha256=b0ts1kbWcwjPSYnZm2rlCylmTLPJRLxDL8z3RmxM5OI,377
 policyengine/core/policy.py,sha256=ExMrUDMvNk_uuOL0cSm0UCzDyGka0t_yk6x4U0Kp6Ww,1635
 policyengine/core/simulation.py,sha256=yvvved75XMcGP3Bj9E2tmKRxvI-DQVZv7k4uTETwBm0,1134
@@ -21,19 +21,19 @@ policyengine/tax_benefit_models/us.py,sha256=G51dAmHo8NJLb2mnbne6iO5eNaatCGUd_2u
 policyengine/tax_benefit_models/uk/__init__.py,sha256=AiA74iED5FEryvUCMfVZi6pYDYuTfQcj9B01h8J5xFA,1105
 policyengine/tax_benefit_models/uk/analysis.py,sha256=O4eYJYF7tsgiuLuiWMU0OXq7ss6U8-vzlg6nC2U8sgU,3175
 policyengine/tax_benefit_models/uk/datasets.py,sha256=-lmj4eG2my2GGmMMkxI1iXobGQW5irBgylEwyV0xU6c,8039
-policyengine/tax_benefit_models/uk/model.py,sha256=HNdqsAKErDw9nruOdj4SiGF2KMopccaGDJ4RTXkdJ1U,9612
+policyengine/tax_benefit_models/uk/model.py,sha256=djCLLBeik9ZGFqe5WXUNVcu1JXjh0U8MXakvncasUj0,9754
 policyengine/tax_benefit_models/uk/outputs.py,sha256=2mYLwQW4QNvrOHtHfm_ACqE9gbmuLxvcCyldRU46s0o,3543
 policyengine/tax_benefit_models/us/__init__.py,sha256=zP-UUQqOc9g0ymyHkweJdi4RVXQDKSR6SUxavUKvV0s,1101
 policyengine/tax_benefit_models/us/analysis.py,sha256=Xf-DT0QjVySs0QG_koCwgvOeWI_scLtv3S3SP8u8ZWc,3253
 policyengine/tax_benefit_models/us/datasets.py,sha256=UwY5GcrVRl7zdmtqKE5TykYRNtOsGzyDm8kRkc98hyw,14708
-policyengine/tax_benefit_models/us/model.py,sha256=lhffJLnE4tr-ch_tHiyH2zP4IMX9_swWomUllb9WdbM,16421
+policyengine/tax_benefit_models/us/model.py,sha256=x3xRoIpXV2idVr0IwPJzujLHqu3qeO-iWN2Sv7Tuj9Q,16563
 policyengine/tax_benefit_models/us/outputs.py,sha256=GT8Eur8DfB9cPQRbSljEl9RpKSNHW80Fq_CBXCybvIU,3519
 policyengine/utils/__init__.py,sha256=1X-VYAWLyB9A0YRHwsGWrqQHns1WfeZ7ISC6DMU5myM,140
 policyengine/utils/dates.py,sha256=HnAqyl8S8EOYp8ibsnMTmECYoDWCSqwL-7A2_qKgxSc,1510
 policyengine/utils/parametric_reforms.py,sha256=4P3U39-4pYTU4BN6JjgmVLUkCkBhRfZJ6UIWTlsjyQE,1155
 policyengine/utils/plotting.py,sha256=ZAzTWz38vIaW0c3Nt4Un1kfrNoXLyHCDd1pEJIlsRg4,5335
-policyengine-3.1.4.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-policyengine-3.1.4.dist-info/METADATA,sha256=ED5nMhV3Tg6uymV-_I6DYvuqbsqiFnccRHNSSUZcOXc,45889
-policyengine-3.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-policyengine-3.1.4.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
-policyengine-3.1.4.dist-info/RECORD,,
+policyengine-3.1.6.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+policyengine-3.1.6.dist-info/METADATA,sha256=Sdl_MCwOgD_eSUaXhrD7J2BmUK0Pgt2pSKXdEVuDak4,45889
+policyengine-3.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+policyengine-3.1.6.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
+policyengine-3.1.6.dist-info/RECORD,,