Update Elterngeld

.pre-commit-config.yaml

@@ -57,7 +57,7 @@ repos:
       - id: blacken-docs
       # exclude: docs/source/how_to_guides/optimization/how_to_specify_constraints.md
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.3
+    rev: v0.6.4
     hooks:
       - id: ruff
       #   args:

CHANGES.md

@@ -6,6 +6,8 @@ releases are available on [Anaconda.org](https://anaconda.org/conda-forge/gettsi
 
 ## Unpublished
 
+- {gh}`756` Refactor Elterngeld module and some small fixes ({ghuser}`MImmesberger`,
+  {ghuser}`ThOrtmann`).
 - {gh}`790` Add unterhaltsvors implementation 2009 to 2016 ({ghuser}`mjbloemer`).
 - {gh}`788` Pension benefit earnings test for early retirees ({ghuser}`MImmesberger`).
 - {gh}`786` Check directly whether child and parent are in same Bedarfsgemeinschaft for

docs/gettsim_objects/input_variables.md

@@ -247,11 +247,40 @@ Weekly working hours of individual
 
 Type: float
 
+(elterngeld_claimed)=
+
+## `elterngeld_claimed`
+
+Individual claims Elterngeld
+
+Type: bool
+
+(elterngeld_nettoeinkommen_vorjahr_m)=
+
+## `elterngeld_nettoeinkommen_vorjahr_m`
+
+Approximation of the net wage in the 12 months before birth of youngest child (according
+to simplified calculation rules). You may let GETTSIM compute this variable via the
+`elterngeld_nettolohn_approximation_m` target in a separate run, which would typically
+be for the previous calendar year.
+
+Type: float
+
+(elterngeld_zu_verst_eink_vorjahr_y_sn)=
+
+## `elterngeld_zu_verst_eink_vorjahr_y_sn`
+
+Taxable income in the 12 months before birth of youngest child. You may let GETTSIM
+compute this variable via the `_zu_verst_eink_mit_kinderfreib_y_sn` target in a separate
+run, which would typically be for the previous calendar year.
+
+Type: float
+
 (bruttolohn_vorj_m)=
 
 ## `bruttolohn_vorj_m`
 
-Monthly wage, previous year
+Gross wage in the previous year
 
 Type: float
 
@@ -295,27 +324,11 @@ Month of retirement
 
 Type: int
 
-(m_elterngeld)=
-
-## `m_elterngeld`
-
-Number of months hh received elterngeld
-
-Type: int
-
-(m_elterngeld_vat_hh)=
-
-## `m_elterngeld_vat_hh`
-
-Number of months father received elterngeld
-
-Type: int
-
-(m_elterngeld_mut_hh)=
+(monate_elterngeldbezug)=
 
-## `m_elterngeld_mut_hh`
+## `monate_elterngeldbezug`
 
-Number of months mother received elterngeld
+Number of months the individual received Elterngeld for the current youngest child.
 
 Type: int
 

src/_gettsim/config.py

@@ -131,6 +131,7 @@ def set_array_backend(backend: str):
     "eink_st_y_sn",
     "soli_st_y_sn",
     "abgelt_st_y_sn",
+    "elterngeld_m",
     "sozialv_beitr_arbeitnehmer_m",
     "ges_rentenv_beitr_arbeitnehmer_m",
     "arbeitsl_v_beitr_arbeitnehmer_m",
@@ -171,6 +172,8 @@ def set_array_backend(backend: str):
     "eink_selbst_m": float,
     "in_priv_krankenv": bool,
     "priv_rentenv_beitr_m": float,
+    "elterngeld_nettoeinkommen_vorjahr_m": float,
+    "elterngeld_zu_verst_eink_vorjahr_y_sn": float,
     "bruttolohn_vorj_m": float,
     "arbeitsstunden_w": float,
     "geburtsjahr": int,
@@ -191,9 +194,8 @@ def set_array_backend(backend: str):
     "monat_renteneintr": int,
     "behinderungsgrad": int,
     "wohnfläche_hh": float,
-    "m_elterngeld": int,
-    "m_elterngeld_vat_hh": int,
-    "m_elterngeld_mut_hh": int,
+    "monate_elterngeldbezug": int,
+    "elterngeld_claimed": bool,
     "in_ausbildung": bool,
     "alleinerz": bool,
     "bewohnt_eigentum_hh": bool,

src/_gettsim/demographic_vars.py

@@ -52,6 +52,8 @@ def _add_grouping_suffixes_to_keys(group_dict: dict[str, dict]) -> dict[str, dic
         "anz_rentner": {"source_col": "rentner", "aggr": "sum"},
         "anz_kinder": {"source_col": "kind", "aggr": "sum"},
         "anz_personen": {"aggr": "count"},
+        "anz_kinder_bis_2": {"source_col": "kind_bis_2", "aggr": "sum"},
+        "anz_kinder_bis_5": {"source_col": "kind_bis_5", "aggr": "sum"},
         "anz_kinder_bis_6": {"source_col": "kind_bis_6", "aggr": "sum"},
         "anz_kinder_bis_15": {"source_col": "kind_bis_15", "aggr": "sum"},
         "anz_kinder_bis_17": {"source_col": "kind_bis_17", "aggr": "sum"},
@@ -65,6 +67,42 @@ def _add_grouping_suffixes_to_keys(group_dict: dict[str, dict]) -> dict[str, dic
 )
 
 
+def kind_bis_2(alter: int, kind: bool) -> bool:
+    """Calculate if child under the age of 3.
+
+    Parameters
+    ----------
+    alter
+        See basic input variable :ref:`alter <alter>`.
+    kind
+        See basic input variable :ref:`kind <kind>`.
+
+    Returns
+    -------
+
+    """
+    out = kind and (alter <= 2)
+    return out
+
+
+def kind_bis_5(alter: int, kind: bool) -> bool:
+    """Calculate if child under the age of 6.
+
+    Parameters
+    ----------
+    alter
+        See basic input variable :ref:`alter <alter>`.
+    kind
+        See basic input variable :ref:`kind <kind>`.
+
+    Returns
+    -------
+
+    """
+    out = kind and (alter <= 5)
+    return out
+
+
 def kind_bis_6(alter: int, kind: bool) -> bool:
     """Calculate if child under the age of 7.
 
@@ -242,7 +280,7 @@ def alter_monate(geburtsdatum: numpy.datetime64, elterngeld_params: dict) -> flo
 
 def jüngstes_kind_oder_mehrling(
     alter_monate: float,
-    alter_monate_jüngstes_mitglied_hh: float,
+    alter_monate_jüngstes_mitglied_fg: float,
     kind: bool,
 ) -> bool:
     """Check if person is the youngest child in the household or a twin, triplet, etc.
@@ -256,16 +294,16 @@ def jüngstes_kind_oder_mehrling(
     ----------
     alter_monate
         See :func:`alter_monate`.
-    alter_monate_jüngstes_mitglied_hh
-        See :func:`alter_monate_jüngstes_mitglied_hh`.
+    alter_monate_jüngstes_mitglied_fg
+        See :func:`alter_monate_jüngstes_mitglied_fg`.
     kind
         See basic input variable :ref:`kind <kind>`.
 
     Returns
     -------
 
     """
-    out = (alter_monate - alter_monate_jüngstes_mitglied_hh < 0.1) and kind
+    out = (alter_monate - alter_monate_jüngstes_mitglied_fg < 0.1) and kind
     return out
 
 

src/_gettsim/parameters/elterngeld.yaml

@@ -20,8 +20,23 @@ höchstbetrag:
   unit: Euro
   reference_period: Month
   2007-01-01:
-    scalar: 1800
+    scalar: 1800.0
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
+max_zu_berücksichtigendes_einkommen:
+  name:
+    de: Maximal zu berücksichtigendes Einkommen vor Geburt.
+    en: Maximum income to be considered before birth.
+  description:
+    de: § 2 (3) BEEG
+    en: null
+  unit: Euro
+  reference_period: Month
+  2007-01-01:
+    scalar: 2700.0
+    reference: BGBl. I S. 2748 Art. 1 G. v. 05.12.2006
+  2012-09-18:
+    scalar: 2770.0
+    reference: Artikel 1 G. v. 10.09.2012 BGBl. I S. 1878
 nettoeinkommen_stufen:
   name:
     de: Nettoeinkommen an 1. und 2. Stufe
@@ -34,12 +49,12 @@ nettoeinkommen_stufen:
   unit: Euro
   reference_period: Month
   2007-01-01:
-    lower_threshold: 1000
-    upper_threshold: 1001
+    lower_threshold: 1000.0
+    upper_threshold: 1001.0
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
   2011-01-01:
-    lower_threshold: 1000
-    upper_threshold: 1201
+    lower_threshold: 1000.0
+    upper_threshold: 1201.0
   reference: Art. 14 G. v. 09.12.2010 BGBl. I S. 1885
 mindestbetrag:
   name:
@@ -90,7 +105,7 @@ eink_schritt_korrektur:
   2007-01-01:
     scalar: 2
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
-geschw_bonus_altersgrenzen_kinder:
+geschwisterbonus_altersgrenzen:
   name:
     de: Altersgrenzen für Geschwisterbonus
     en: Age limit for sibling bonus
@@ -105,7 +120,7 @@ geschw_bonus_altersgrenzen_kinder:
   2007-01-01:
     3: 2
     6: 3
-geschw_bonus_aufschlag:
+geschwisterbonus_aufschlag:
   name:
     de: Geschwisterbonus als prozentualer Aufschlag
     en: Sibling Bonus, percentage top-up
@@ -116,7 +131,7 @@ geschw_bonus_aufschlag:
   2007-01-01:
     scalar: 0.1
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
-geschw_bonus_minimum:
+geschwisterbonus_minimum:
   name:
     de: Minimaler Geschwisterbonus als Euro-Betrag
     en: Sibling Bonus, minimal amount
@@ -126,7 +141,7 @@ geschw_bonus_minimum:
   unit: Euro
   reference_period: Month
   2007-01-01:
-    scalar: 75
+    scalar: 75.0
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
 mehrlingbonus:
   name:
@@ -138,7 +153,7 @@ mehrlingbonus:
   unit: Euro
   reference_period: Month
   2007-01-01:
-    scalar: 300
+    scalar: 300.0
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
 sozialv_pausch:
   name:
@@ -152,23 +167,84 @@ sozialv_pausch:
     scalar: 0.21
     reference: Art. 1 G. v. 10.09.2012 BGBl. I S. 1878
     note: .09 + .1 + .02
-max_monate_paar:
+max_monate_mit_partnermonate:
   name:
-    de: Maximale Anzahl an Monaten, in denen ein Paar Elterngeld erhält
-    en: Maximum number of months a couple may receive parental benefit.
+    de: Maximale Anzahl an Monaten, inklusiver Partnermonate.
+    en: Maximum number of months, including "Partnermonate".
   description:
-    de: § 4 (3) BEEG
-    en: null
+    de: >-
+      Basismonate plus "Partnermonate" bei gleichzeitiger Inanspruchnahme von Elterngeld
+      bei Paaren. Basismonate bei Alleinerziehenden.
+  reference: § 4 (3) BEEG
   2007-01-01:
     scalar: 14
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
-max_monate_ind:
+max_monate_ohne_partnermonate:
   name:
-    de: Maximale Anzahl an Monaten, die jedes Elternteil Elterngeld erhält
-    en: Maximum number of months an individual parent may receive parental benefit.
+    de: >-
+      Maximale Anzahl an Monaten bei Paaren, die nicht gleichzeitig Elterngeld beziehen.
+    en: Maximum number of months for couples not receiving Elterngeld simultaneously.
   description:
-    de: § 4 (3) BEEG
+    de: Basismonate ohne Partnermonate.
     en: null
+  reference: § 4 (3) BEEG
   2007-01-01:
     scalar: 12
     reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
+max_eink_vorj:
+  description:
+    de: >-
+      Maximales zu versteuerndes Einkommen im letzten Veranlagungszeitraum vor Geburt
+      des Kindes. Einkommen über dieser Grenze schließt den Bezug von Elterngeld aus (§
+      1 (8) BEEG).
+    en: >-
+      Maximum taxable income in the year before the birth of the child. Income above
+      this threshold disqualifies the parent from receiving Elterngeld.
+  reference:
+    de: null
+    en: null
+  unit: Euro
+  2011-01-01:
+    single: 250000.0
+    paar: 500000.0
+    reference: Art. 14 G. v. 09.12.2010 BGBl. I S. 1885
+  2021-09-01:
+    deviation_from: previous
+    paar: 300000.0
+    reference: Art. 1 G. v. 15.02.2021 BGBl. I S. 239
+  2024-04-01:
+    scalar: 200000.0
+    reference: >-
+      Single: Art. 7 G. v. 27.03.2024 BGBl. 2024 I Nr. 107, Paar: Art. 1 G. v.
+      22.12.2023 BGBl. 2023 I Nr. 412
+  2025-04-01:
+    scalar: 175000.0
+    reference: >-
+      Single: Art. 7 G. v. 27.03.2024 BGBl. 2024 I Nr. 107, Paar: Art. 1 G. v.
+      22.12.2023 BGBl. 2023 I Nr. 412
+max_arbeitsstunden_w:
+  name:
+    de: >-
+      Maximale Wochenstunden die bei Elterngeldbezug gearbeitet werden dürfen
+    en: >-
+      Maximum amount of weekly hours one is allowed to work, when receiving Elterngeld
+  description:
+    de: §1 (6) BEEG
+    en: null
+  2007-01-01:
+    scalar: 30.0
+    reference: Art. 1 G. v. 05.12.2006 BGBl. I S. 2748
+  2021-09-01:
+    scalar: 32.0
+    reference: Art. 1 G. v. 15.02.2021 BGBl. I S. 239
+rounding:
+  _untere_lohnersatzanteil_grenze_minus_nettoeinkommen:
+    1980-01-01:
+      base: 2
+      direction: down
+      reference: §2 (2) BEEG
+  _nettoeinkommen_minus_obere_lohnersatzanteil_grenze:
+    1980-01-01:
+      base: 2
+      direction: down
+      reference: §2 (2) BEEG

src/_gettsim/synthetic.py

@@ -297,6 +297,7 @@ def create_constant_across_households_variables(df, n_adults, n_children, policy
         "m_schul_ausbild": 10.0,
         "m_kind_berücks_zeit": 24.0,
         "m_pfleg_berücks_zeit": 1.0,
+        "elterngeld_nettoeinkommen_vorjahr_m": 20000.0,
         "geburtsjahr": policy_year - df["alter"],
         "jahr_renteneintr": policy_year - df["alter"] + 67,
         "grundr_zeiten": (df["alter"] - 20).clip(lower=0) * 12,