feat: method to replace all parameters

Author: lars-reimann

docs/tutorials/parameters.ipynb

@@ -16,9 +16,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "import copy\n",
     "\n",
@@ -30,7 +28,9 @@
     "    compute_taxes_and_transfers,\n",
     "    create_synthetic_data,\n",
     ")"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -56,12 +56,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "environment = PolicyEnvironment.for_date(\"2020\")"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -74,12 +74,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "print(*environment.params.keys(), sep=\"\\n\")"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -90,12 +90,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "print(*environment.params[\"kindergeld\"].keys(), sep=\"\\n\")"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -116,12 +116,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "environment.params[\"kindergeld\"][\"kindergeld\"]"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -136,12 +136,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "policy_params_new = copy.deepcopy(environment.params)"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -152,14 +152,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# Loop through policy paramaters to add the special child bonus.\n",
     "for n in policy_params_new[\"kindergeld\"][\"kindergeld\"]:\n",
     "    policy_params_new[\"kindergeld\"][\"kindergeld\"][n] += 20"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -170,12 +170,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "policy_params_new[\"kindergeld\"][\"kindergeld\"]"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -195,9 +195,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "data = create_synthetic_data(\n",
     "    n_adults=2,\n",
@@ -224,7 +222,9 @@
     "    \"sum_ges_rente_priv_rente_m\"\n",
     "]\n",
     "data.head()"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "attachments": {},
@@ -238,9 +238,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "kindergeld_status_quo = compute_taxes_and_transfers(\n",
     "    data=data,\n",
@@ -249,7 +247,9 @@
     ")\n",
     "\n",
     "kindergeld_status_quo[[\"kindergeld_m_hh\"]]"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -260,18 +260,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
-    "environment_new = PolicyEnvironment(environment.functions, policy_params_new)\n",
+    "environment_new = environment.replace_all_parameters(policy_params_new)\n",
     "kindergeld_new = compute_taxes_and_transfers(\n",
     "    data=data,\n",
     "    environment=environment_new,\n",
     "    targets=\"kindergeld_m_hh\",\n",
     ")\n",
     "kindergeld_new[[\"kindergeld_m_hh\"]]"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -284,20 +284,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# Group data by household id and sum the gross monthly income.\n",
     "total_income_m_hh = data.groupby(\"hh_id\")[\"bruttolohn_m\"].sum()\n",
     "total_income_m_hh.tail(10)"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# Create DataFrame with relevant columns for plotting.\n",
     "df = pd.DataFrame()\n",
@@ -306,7 +304,9 @@
     "df[\"hh_id\"] = data[\"hh_id\"]\n",
     "df = df.drop_duplicates(\"hh_id\").set_index(\"hh_id\")\n",
     "df[\"Income (per household)\"] = total_income_m_hh"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -317,9 +317,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "fig = px.line(\n",
     "    data_frame=df,\n",
@@ -331,7 +329,9 @@
     "    xaxis_title=\"Monthly gross income in € (per household)\",\n",
     "    yaxis_title=\"Kindergeld in € per month\",\n",
     ")"
-   ]
+   ],
+   "outputs": [],
+   "execution_count": null
   },
   {
    "cell_type": "markdown",
@@ -354,6 +354,11 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3"
+  },
+  "kernelspec": {
+   "name": "python3",
+   "language": "python",
+   "display_name": "Python 3 (ipykernel)"
   }
  },
  "nbformat": 4,

src/_gettsim/policy_environment.py

@@ -109,7 +109,6 @@ def upsert_functions(
             The policy environment with the new functions.
         """
         new_functions = {**self._functions}
-
         for function in functions:
             f = (
                 function
@@ -124,6 +123,29 @@ def upsert_functions(
 
         return result
 
+    def replace_all_parameters(
+        self, params: dict[str, Any]
+    ):
+        """
+        Replace all parameters of the policy environment. Note that this
+        method does not modify the current policy environment but returns a new one.
+
+        Parameters
+        ----------
+        params:
+            The new parameters.
+
+        Returns
+        -------
+        new_environment:
+            The policy environment with the new parameters.
+        """
+        result = object.__new__(PolicyEnvironment)
+        result._functions = self._functions # noqa: SLF001
+        result._params = params  # noqa: SLF001
+
+        return result
+
 
 def set_up_policy_environment(date: datetime.date | str | int) -> PolicyEnvironment:
     """