ttsim-dev · lars-reimann · Nov 23, 2023 · Nov 17, 2023 · Nov 17, 2023 · Nov 17, 2023
diff --git a/CHANGES.md b/CHANGES.md
@@ -6,6 +6,7 @@ releases are available on [Anaconda.org](https://anaconda.org/conda-forge/gettsi
 
 ## Unpublished
 
+- {gh}`662` Replace `hh` in function names by `bg`/`fg`/`vg` ({ghuser}`lars-reimann`).
 - {gh}`659` Add rounding to Unterhaltsvorschuss, ESt, Wohngeld, Kinderzuschlag.
   ({ghuser}`MImmesberger`).
 - {gh}`655` Correct calculation of Lohnsteuer for 2015 to 2023 ({ghuser}`JakobWegmann`).

diff --git a/docs/geps/gep-01.md b/docs/geps/gep-01.md
@@ -42,7 +42,7 @@ a nutshell and without explanations, these conventions are:
      Internal variables should be used sparingly.
 
 1. If names need to be concatenated for making clear what a column name refers to (e.g.,
-   `arbeitsl_geld_2_vermög_freib_hh` vs. `grunds_im_alter_vermög_freib_hh`), the group
+   `arbeitsl_geld_2_vermög_freib_bg` vs. `grunds_im_alter_vermög_freib_vg`), the group
    (i.e., the tax or transfer) that a variable refers to appears first.
 
 1. Because of the necessity of concatenated column names, there will be conflicts
@@ -112,7 +112,7 @@ changed, even if it leads to long variable names (e.g., `kinderfreib`,
 less error-prone.
 
 If names need to be concatenated for making clear what a column name refers to (e.g.,
-`arbeitsl_geld_2_vermög_freib_hh` vs. `grunds_im_alter_vermög_freib_hh`), the group
+`arbeitsl_geld_2_vermög_freib_bg` vs. `grunds_im_alter_vermög_freib_vg`), the group
 (i.e., the tax or transfer) that a variable refers to appears first.
 
 If a column has a reference to a time unit (i.e., any flow variable like earnings or
@@ -123,7 +123,7 @@ the relevant unit, an underscore plus one of {`hh`, `tu`} will indicate the leve
 aggregation.
 
 Time unit identifiers always appear before unit identifiers (e.g.,
-`arbeitsl_geld_2_m_hh`).
+`arbeitsl_geld_2_m_bg`).
 
 ## Parameters of the taxes and transfers system
 
@@ -136,7 +136,7 @@ general naming considerations here.
 - Parameter names should be generally be aligned with relevant column names. However,
   since the group is not repeated for the parameter, it is often better not to
   abbreviate them (e.g., `wohngeld_params["vermögensgrundfreibetrag"]` for the parameter
-  and `wohngeld_nach_vermög_check_m_hh` for a column derived from it).
+  and `wohngeld_nach_vermög_check_m_vg` for a column derived from it).
 
 ## Other Python identifiers (Functions, Variables)
 

diff --git a/docs/geps/gep-04.md b/docs/geps/gep-04.md
@@ -250,16 +250,16 @@ Using a different reduction function than the sum is as easy as explicitly speci
 `my_col_hh`.
 
 Consider the following example: the function `kindergeld_m` calculates the
-individual-level child benefit payment. `arbeitsl_geld_2_m_hh` calculates
+individual-level child benefit payment. `arbeitsl_geld_2_m_bg` calculates
 Arbeitslosengeld 2 on the household level (as indicated by the suffix). One necessary
 input of this function is the sum of all child benefits on the household level. There is
 no function or input column `kindergeld_m_hh`.
 
 By including `kindergeld_m_hh` as an argument in the definition of
-`arbeitsl_geld_2_m_hh` as follows:
+`arbeitsl_geld_2_m_bg` as follows:
 
 ```python
-def arbeitsl_geld_2_m_hh(kindergeld_m_hh, other_arguments):
+def arbeitsl_geld_2_m_bg(kindergeld_m_hh, other_arguments):
     ...
 ```
 

diff --git a/docs/gettsim_objects/variables_out.md b/docs/gettsim_objects/variables_out.md
@@ -34,14 +34,14 @@ You can find their individual calculation in the documentation of all {ref}`func
   - Solidarity surcharge on withholding tax
 * - {func}`unterhaltsvors_m <_gettsim.functions.unterhaltsvors_m>`
   - Alimony advance payment
-* - {func}`arbeitsl_geld_2_m_hh <_gettsim.functions.arbeitsl_geld_2_m_hh>`
+* - {func}`arbeitsl_geld_2_m_bg <_gettsim.functions.arbeitsl_geld_2_m_bg>`
   - Monthly subsistence payment on household level
-* - {func}`kinderzuschl_m_hh <_gettsim.functions.kinderzuschl_m_hh>`
+* - {func}`kinderzuschl_m_bg <_gettsim.functions.kinderzuschl_m_bg>`
   - Monthly additional child benefit, household sum
 * - {func}`elterngeld_m <_gettsim.functions.elterngeld_m>`
   - Monthly parental leave benefit
-* - {func}`wohngeld_m_hh <_gettsim.functions.wohngeld_m_hh>`
+* - {func}`wohngeld_m_vg <_gettsim.functions.wohngeld_m_vg>`
   - Monthly housing benefit on household level
-* - {func}`grunds_im_alter_m_hh <_gettsim.functions.grunds_im_alter_m_hh>`
+* - {func}`grunds_im_alter_m_vg <_gettsim.functions.grunds_im_alter_m_vg>`
   - Monthly subsistence payment for retirees on household level
 ```
diff --git a/docs/tutorials/policy_functions.ipynb b/docs/tutorials/policy_functions.ipynb
@@ -71,22 +71,22 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def arbeitsl_geld_2_m_hh(\n",
-    "    arbeitsl_geld_2_vor_vorrang_m_hh,\n",
-    "    # wohngeld_vorrang_hh,\n",
-    "    # kinderzuschl_vorrang_hh,\n",
-    "    # wohngeld_kinderzuschl_vorrang_hh,\n",
+    "def arbeitsl_geld_2_m_bg(\n",
+    "    arbeitsl_geld_2_vor_vorrang_m_bg,\n",
+    "    # wohngeld_vorrang_vg,\n",
+    "    # kinderzuschl_vorrang_bg,\n",
+    "    # wohngeld_kinderzuschl_vorrang_vg,\n",
     "    erwachsene_alle_rentner_hh,\n",
     "):\n",
     "    if (\n",
-    "        # wohngeld_vorrang_hh\n",
-    "        # | kinderzuschl_vorrang_hh\n",
-    "        # | wohngeld_kinderzuschl_vorrang_hh\n",
+    "        # wohngeld_vorrang_vg\n",
+    "        # | kinderzuschl_vorrang_bg\n",
+    "        # | wohngeld_kinderzuschl_vorrang_vg\n",
     "        erwachsene_alle_rentner_hh\n",
     "    ):\n",
     "        out = 0.0\n",
     "    else:\n",
-    "        out = arbeitsl_geld_2_vor_vorrang_m_hh\n",
+    "        out = arbeitsl_geld_2_vor_vorrang_m_bg\n",
     "\n",
     "    return out"
    ]
@@ -113,7 +113,7 @@
    "outputs": [],
    "source": [
     "policy_functions_no_check = copy.deepcopy(policy_functions)\n",
-    "policy_functions_no_check[\"arbeitsl_geld_2_m_hh\"] = arbeitsl_geld_2_m_hh"
+    "policy_functions_no_check[\"arbeitsl_geld_2_m_bg\"] = arbeitsl_geld_2_m_bg"
    ]
   },
   {
@@ -162,9 +162,9 @@
    "source": [
     "For this data we can now compare the results of using GETTSIM with the `policy_functions_no_check` and the usual `policy_functions`. \n",
     "\n",
-    "We should expect to see positive values for `wohngeld_m_hh`, `kinderzuschl_m_hh` and `arbeitsl_geld_2_m_hh` at the same time if we do not check which combination of transfers is optimal (`policy_functions_no_check`).\n",
+    "We should expect to see positive values for `wohngeld_m_vg`, `kinderzuschl_m_bg` and `arbeitsl_geld_2_m_bg` at the same time if we do not check which combination of transfers is optimal (`policy_functions_no_check`).\n",
     "\n",
-    "On the other hand, if we use the default version of the `policy_functions`, `wohngeld_m_hh` and `kinderzuschl_m_hh` should be zero as long as `arbeitsl_geld_2_m_hh` is positive (and the other way around), as it is a characteristic of the German taxes and transfers system that *Wohngeld* and *Kinderzuschlag* cannot be received in combination with *Arbeitslosengeld 2*."
+    "On the other hand, if we use the default version of the `policy_functions`, `wohngeld_m_vg` and `kinderzuschl_m_bg` should be zero as long as `arbeitsl_geld_2_m_bg` is positive (and the other way around), as it is a characteristic of the German taxes and transfers system that *Wohngeld* and *Kinderzuschlag* cannot be received in combination with *Arbeitslosengeld 2*."
    ]
   },
   {
@@ -173,7 +173,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "targets = [\"wohngeld_m_hh\", \"kinderzuschl_m_hh\", \"arbeitsl_geld_2_m_hh\"]"
+    "targets = [\"wohngeld_m_vg\", \"kinderzuschl_m_bg\", \"arbeitsl_geld_2_m_bg\"]"
    ]
   },
   {
@@ -231,7 +231,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "On first glance, both figures look quite confusing because of the complexity of the German taxes and transfers system. But if we take a closer look, the figures confirm our expectations. If we let GETTSIM check for the most favorable combination of transfers, ```wohngeld_m_hh``` and ```kinderzuschl_m_hh``` are zero as long as `arbeitsl_geld_2_m_hh` is positive (i.e. the best option for the household) and the other way around. \n",
+    "On first glance, both figures look quite confusing because of the complexity of the German taxes and transfers system. But if we take a closer look, the figures confirm our expectations. If we let GETTSIM check for the most favorable combination of transfers, ```wohngeld_m_vg``` and ```kinderzuschl_m_bg``` are zero as long as `arbeitsl_geld_2_m_bg` is positive (i.e. the best option for the household) and the other way around. \n",
     "\n",
     "If we do not let GETTSIM do this check, this does not hold any longer and all transfers can be positive at the same time (which is what we were trying to achieve). \n",
     "\n",
@@ -249,11 +249,11 @@
     "result_no_check_p = compute_taxes_and_transfers(\n",
     "    data=data,\n",
     "    params=policy_params,\n",
-    "    functions=[policy_functions, arbeitsl_geld_2_m_hh],\n",
+    "    functions=[policy_functions, arbeitsl_geld_2_m_bg],\n",
     "    targets=[\n",
-    "        \"wohngeld_m_hh\",\n",
-    "        \"kinderzuschl_m_hh\",\n",
-    "        \"arbeitsl_geld_2_m_hh\",\n",
+    "        \"wohngeld_m_vg\",\n",
+    "        \"kinderzuschl_m_bg\",\n",
+    "        \"arbeitsl_geld_2_m_bg\",\n",
     "    ],\n",
     ")"
    ]
@@ -266,11 +266,11 @@
     "\n",
     "There are three important points:\n",
     "\n",
-    "1. Note that ```arbeitsl_geld_2_m_hh``` has the same function name as a pre-defined function inside GETTSIM. Thus, the internal function will be replaced with this version.\n",
+    "1. Note that ```arbeitsl_geld_2_m_bg``` has the same function name as a pre-defined function inside GETTSIM. Thus, the internal function will be replaced with this version.\n",
     "\n",
     "2. In general, if there are multiple functions with the same name, internal functions have the lowest precedence. After that, the elements in the list passed to the ```functions``` argument are evaluated element by element. The functions in the leftmost element have the lowest precedence and the functions in the rightmost element have the highest.\n",
     "\n",
-    "3. If ```policy_functions``` would not be necessary for this example, you can also directly pass the ```arbeitsl_geld_2_m_hh``` function to the ```functions``` argument.\n",
+    "3. If ```policy_functions``` would not be necessary for this example, you can also directly pass the ```arbeitsl_geld_2_m_bg``` function to the ```functions``` argument.\n",
     "\n",
     "### Multiple Functions\n",
     "\n",
@@ -283,7 +283,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def kinderzuschl_m_hh(\n",
+    "def kinderzuschl_m_bg(\n",
     "    kindergeld_anspruch, kumulativer_kindergeld_anspruch_tu, kindergeld_params\n",
     "):\n",
     "    \"\"\"Calculate the preliminary kindergeld.\n",
@@ -317,7 +317,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If you edit ```arbeitsl_geld_2_m_hh``` and ```kinderzuschl_m_hh```, your two options to make GETTSIM incorporate your changes would be:\n",
+    "If you edit ```arbeitsl_geld_2_m_bg``` and ```kinderzuschl_m_bg```, your two options to make GETTSIM incorporate your changes would be:\n",
     "\n",
     "**Alternative 1:**"
    ]
@@ -329,8 +329,8 @@
    "outputs": [],
    "source": [
     "policy_functions_reformed = copy.deepcopy(policy_functions)\n",
-    "policy_functions_reformed[\"arbeitsl_geld_2_m_hh\"] = arbeitsl_geld_2_m_hh\n",
-    "policy_functions_reformed[\"kinderzuschl_m_hh\"] = kinderzuschl_m_hh"
+    "policy_functions_reformed[\"arbeitsl_geld_2_m_bg\"] = arbeitsl_geld_2_m_bg\n",
+    "policy_functions_reformed[\"kinderzuschl_m_bg\"] = kinderzuschl_m_bg"
    ]
   },
   {
@@ -349,12 +349,12 @@
     "df = compute_taxes_and_transfers(\n",
     "    data=data,\n",
     "    params=policy_params,\n",
-    "    functions=[policy_functions, arbeitsl_geld_2_m_hh, kinderzuschl_m_hh],\n",
+    "    functions=[policy_functions, arbeitsl_geld_2_m_bg, kinderzuschl_m_bg],\n",
     "    targets=[\n",
-    "        \"wohngeld_m_hh\",\n",
-    "        \"kinderzuschl_m_hh\",\n",
-    "        \"arbeitsl_geld_2_m_hh\",\n",
-    "        \"kinderzuschl_m_hh\",\n",
+    "        \"wohngeld_m_vg\",\n",
+    "        \"kinderzuschl_m_bg\",\n",
+    "        \"arbeitsl_geld_2_m_bg\",\n",
+    "        \"kinderzuschl_m_bg\",\n",
     "    ],\n",
     ")"
    ]

diff --git a/src/_gettsim/config.py b/src/_gettsim/config.py
@@ -103,11 +103,11 @@ def set_array_backend(backend: str):
     "ges_pflegev_beitr_m",
     "arbeitsl_geld_m",
     "kindergeld_m_tu",
-    "arbeitsl_geld_2_m_hh",
-    "kinderzuschl_m_hh",
-    "wohngeld_m_hh",
+    "arbeitsl_geld_2_m_bg",
+    "kinderzuschl_m_bg",
+    "wohngeld_m_vg",
     "unterhaltsvors_m_hh",
-    "grunds_im_alter_m_hh",
+    "grunds_im_alter_m_vg",
     "ges_rente_m",
 ]
 

diff --git a/src/_gettsim/parameters/wohngeld.yaml b/src/_gettsim/parameters/wohngeld.yaml
@@ -475,23 +475,6 @@ koeffizienten_berechnungsformel:
       a: -0.12
       b: 0.0001152
       c: 0.0000251
-haushaltsgröße_hhn:
-  name:
-    de: Haushaltsgrößen, die beim Wohngeld berücksichtigt werden
-    en: Household sizes taken into account for housing benefit
-  description:
-    de: >-
-      Haushalte mit mehr als 5 Mitgliedern haben einen festgesetzten Höchstbetrag für
-      Miete und Belastung. Das Wohngeld für bis zu 12 Haushaltsmitglieder kann durch die
-      Formel berechnet werden.
-    en: >-
-      Households with more than 5 members have a fixed maximum amount for rent and
-      burden. The housing benefit for up to 12 household members can be calculated using
-      the formula be calculated.
-  reference: § 19 Abs.1 WoGG
-  1984-01-01:
-    1: 5
-    2: 12
 bonus_sehr_große_haushalte:
   name:
     de: Zusätzlicher Betrag für große Haushalte
@@ -1987,7 +1970,7 @@ klimakomponente_m:
     5: 39.20
     jede_weitere_person: 4.8
 rounding:
-  wohngeld_vor_vermög_check_m_hh:
+  wohngeld_vor_vermög_check_m_vg:
     1970-01-01:
       base: 1
       direction: nearest