GEP 10: unit fixes for arbeitslosengeld_2/wohngeld + bump ttsim to 4dc065aa

- restore eg→bg transfer cast in anspruchshöhe_m; berechtigte_wohnfläche cast-free
  via the schedule param-function output unit + max/min shim
- wohngeld basisbetrag/anspruchshöhe/betrag chain to .PER_WTHH; drop redundant casts
- wohngeld EUR-only heating/climate lookups: raw output_unit -> _PER_HH, drop casts

Author: MImmesberger

CHANGES.md

@@ -15,14 +15,8 @@ All releases are available on [Anaconda.org](https://anaconda.org/conda-forge/ge
 
 ## Unreleased
 
-- {gh}`1192` Annotate the taxes and transfers system with units and dimensions (GEP 10).
-  Every `@policy_function`, `@policy_input`, `@param_function` and
-  `@group_creation_function` declares a unit, as does every parameter in the YAML files.
-  The euro is registered as the base currency and the Deutsche Mark relative to it, so
-  that policy dates before 2002 compute in the currency of their day.
-  ({ghuser}`MImmesberger`)
-- {gh}`1192` Rename columns whose name did not match the quantity they carry. Most gain
-  the suffix of the period they are measured over: `basistarif`, `splittingtarif`,
+- {gh}`1212` GEP 10 Rollout and some related column renamings: Most gain the suffix of
+  the period they are measured over: `basistarif`, `splittingtarif`,
   `tarif_klassen_5_und_6` (and their `_mit_kinderfreibetrag` variants),
   `einkommensgrenze_ohne_geschwisterbonus` (and its two age variants),
   `vorsorge_arbeitslosenversicherungsbeiträge`,
@@ -33,8 +27,7 @@ All releases are available on [Anaconda.org](https://anaconda.org/conda-forge/ge
   `satz` all gain `_m`. Two lose a suffix they should never have had, being shares
   rather than flows: `anteil_steuerfälliger_einnahmen_y` and
   `mehrbedarf_alleinerziehend_m`. `gesamteinkommen_y` becomes `gesamteinkommen_y_sn`,
-  naming the level it is aggregated to. There are no aliases; the old names are gone.
-  ({ghuser}`MImmesberger`)
+  naming the level it is aggregated to. ({ghuser}`MImmesberger`)
 - {gh}`1206` Update Rentenwert 2025, 2026. ({ghuser}`cmdr-majus`)
 - {gh}`1156` Collection of all Grundsicherung im Alter / Wohngeld PRs ({gh}`1163`,
   {gh}`1167`, {gh}`1164`, {gh}`1159`, {gh}`1154`, {gh}`1155`, {gh}`1178`).

docs/geps/params-schema.json

@@ -1,11 +1,11 @@
 {
-  "$comment": "If you change this file, always change it in both locations:  1. ttsim/src/ttsim/params-schema.json  2. gettsim/docs/geps/params-schema.json",
+  "$comment": "Keep in sync with ttsim/src/ttsim/params-schema.json, except unitToken: this GETTSIM copy pins the grouping levels to Germany's, ttsim leaves them open.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
     "unitToken": {
-      "$comment": "A fully-spelled compositional unit (GEP 10): a base optionally divided by an area, a period, and a grouping level, joined by `_PER_` (e.g. DIMENSIONLESS, CURRENCY_PER_MONTH_PER_BG, SILVER_PENNY_PER_FAM, PERSON_COUNT_PER_HH). Bases and grouping levels are open (per-package currencies, per-build levels), so this is a coarse pattern; `parse_compositional_unit` validates the grammar at load time.",
+      "$comment": "Bases stay open (currencies register per package); the grouping level, if present, must be one of Germany's.",
       "type": "string",
-      "pattern": "^[A-Z][A-Z0-9_]*$"
+      "pattern": "^[A-Z][A-Z0-9]*(?:_(?!PER_)[A-Z0-9]+)*(?:_PER_(?:SQUARE_METER|HOURS))?(?:_PER_(?:YEAR|QUARTER|MONTH|WEEK|DAY))?(?:_PER_(?:HH|EHE|FG|BG|EG|WTHH|SN))?$"
     },
     "unitDeclaration": {
       "oneOf": [
@@ -157,7 +157,6 @@
               ]
             },
             "else": {
-              "$comment": "Scalar/dict parameter: `unit:` may sit at the top level (shared by every date) or one level lower, inside each date-specific key, so a parameter re-denominated over time can spell its unit symmetrically per date. The schema therefore does not require `unit:` here; the build-time mandatory-units check (`fail_if_environment_units_are_missing`) is the guarantee that every active leaf resolves to a unit (GEP 10).",
               "allOf": [
                 { "not": { "required": ["input_unit"] } },
                 { "not": { "required": ["output_unit"] } }
@@ -166,7 +165,6 @@
           }
         },
         {
-          "$comment": "A scalar parameter takes its period from a time suffix on its name and declares a single fully-spelled `unit:` token, not a per-leaf mapping (which only a dict or require_converter parameter may use).",
           "if": {
             "properties": { "type": { "const": "scalar" } },
             "required": ["type"]

docs/how_to_guides/modifications_of_policy_environments.ipynb

@@ -222,17 +222,16 @@
     "- `leaf_name`: The leaf name of the parameter in GETTSIM's policy environment.\n",
     "- `start_date`: The date from which the parameter is valid (if applicable).\n",
     "- `end_date`: The date until which the parameter is valid (if applicable).\n",
-    "- `unit`: The unit of the parameter (GEP 10). Parameters that map an input to an output\n",
-    "  — the lookup tables and piecewise polynomials — leave this unset and declare\n",
-    "  `input_unit` and `output_unit` instead.\n",
+    "- `unit`: The unit of the parameter (GEP 10).\n",
     "- `name`: The name of the parameter.\n",
     "- `description`: A more elaborate description of the parameter.\n",
     "- `value`: The value of the parameter.\n",
     "- `note`: Some notes (if applicable).\n",
     "- `reference`: A legal reference.\n",
     "\n",
-    "When modifying parameters, you will mostly care about the `value` attribute. The unit is\n",
-    "required, so state the same one the parameter you replace declares.\n",
+    "When modifying parameters, you will mostly care about the `value` attribute. Every\n",
+    "parameter must declare a `unit` (GEP 10); keep the one the original declares.\n",
+    "Parameters state a concrete currency, e.g. `TTSIMUnit.EUR.PER_YEAR`.\n",
     "\n",
     "### Scalar Parameters\n",
     "\n",
@@ -315,9 +314,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gettsim.tt import ScalarParam, Unit\n",
+    "from gettsim.tt import ScalarParam, TTSIMUnit\n",
     "\n",
-    "higher_arbeitnehmerpauschbetrag = ScalarParam(value=1600, unit=Unit.EUR.PER_YEAR)"
+    "higher_arbeitnehmerpauschbetrag = ScalarParam(value=1600, unit=TTSIMUnit.EUR.PER_YEAR)"
    ]
   },
   {
@@ -419,7 +418,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gettsim.tt import DictParam, Unit\n",
+    "from gettsim.tt import DictParam, TTSIMUnit\n",
     "\n",
     "# Step 1: Create a copy of the status quo policy environment.\n",
     "higher_kinderfreibetrag_pe = copy_environment(status_quo_environment)\n",
@@ -430,7 +429,7 @@
     "        \"betreuung_erziehung_ausbildung\": 1464,\n",
     "        \"sächliches_existenzminimum\": 4000,\n",
     "    },\n",
-    "    unit=Unit.EUR.PER_YEAR,\n",
+    "    unit=TTSIMUnit.EUR.PER_YEAR,\n",
     ")\n",
     "\n",
     "# Step 3: Insert the new parameter into the copied policy environment\n",
@@ -557,7 +556,7 @@
    "source": [
     "from gettsim.tt import (\n",
     "    ConsecutiveIntLookupTableParam,\n",
-    "    Unit,\n",
+    "    TTSIMUnit,\n",
     "    get_consecutive_int_lookup_table_param_value,\n",
     ")\n",
     "\n",
@@ -581,8 +580,8 @@
     "        },\n",
     "        xnp=np,\n",
     "    ),\n",
-    "    input_unit=Unit.CALENDAR_YEAR,\n",
-    "    output_unit=Unit.YEARS,\n",
+    "    input_unit=TTSIMUnit.CALENDAR_YEAR,\n",
+    "    output_unit=TTSIMUnit.YEARS,\n",
     ")\n",
     "\n",
     "# Step 3: Insert the new parameter into the copied policy environment\n",
@@ -687,7 +686,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gettsim.tt import PiecewisePolynomialParam, Unit, get_piecewise_parameters\n",
+    "from gettsim.tt import PiecewisePolynomialParam, TTSIMUnit, get_piecewise_parameters\n",
     "\n",
     "increased_behindertenpauschbetrag = PiecewisePolynomialParam(\n",
     "    value=get_piecewise_parameters(\n",
@@ -705,8 +704,8 @@
     "        leaf_name=\"parameter_behindertenpauschbetrag\",\n",
     "        xnp=np,\n",
     "    ),\n",
-    "    input_unit=Unit.DIMENSIONLESS,\n",
-    "    output_unit=Unit.EUR.PER_YEAR,\n",
+    "    input_unit=TTSIMUnit.DIMENSIONLESS,\n",
+    "    output_unit=TTSIMUnit.EUR.PER_YEAR,\n",
     ")\n",
     "\n",
     "increased_behindertenpauschbetrag_pe = copy_environment(status_quo_environment)\n",
@@ -779,7 +778,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gettsim.tt import RawParam, Unit\n",
+    "from gettsim.tt import RawParam, TTSIMUnit\n",
     "\n",
     "# Step 1: Create a copy of the status quo policy environment.\n",
     "increased_tax_exemption_pe = copy_environment(status_quo_environment)\n",
@@ -800,8 +799,8 @@
     "            {\"interval\": \"[277825, inf)\", \"slope\": 0.45, \"quadratic\": 0},\n",
     "        ],\n",
     "    },\n",
-    "    input_unit=Unit.EUR.PER_YEAR,\n",
-    "    output_unit=Unit.EUR.PER_YEAR,\n",
+    "    input_unit=TTSIMUnit.EUR.PER_YEAR,\n",
+    "    output_unit=TTSIMUnit.EUR.PER_YEAR,\n",
     ")\n",
     "\n",
     "# Step 3: Insert the new parameter into the copied policy environment\n",
@@ -836,7 +835,7 @@
     "dictionary.\n",
     "\n",
     "```python\n",
-    "@param_function(unit=Unit.CURRENCY.PER_YEAR)\n",
+    "@param_function(unit=TTSIMUnit.CURRENCY.PER_YEAR)\n",
     "def kinderfreibetrag_pro_kind_y(parameter_kinderfreibetrag: dict[str, float]) -> float:\n",
     "    return sum(parameter_kinderfreibetrag.values())\n",
     "```"
@@ -868,7 +867,7 @@
     "The original function looks like this:\n",
     "\n",
     "```python\n",
-    "@param_function(unit=Unit.CURRENCY.PER_YEAR)\n",
+    "@param_function(unit=TTSIMUnit.CURRENCY.PER_YEAR)\n",
     "def kinderfreibetrag_pro_kind_y(\n",
     "    parameter_kinderfreibetrag: dict[str, float],\n",
     ") -> float:\n",
@@ -885,10 +884,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gettsim.tt import Unit, param_function\n",
+    "from gettsim.tt import TTSIMUnit, param_function\n",
     "\n",
     "\n",
-    "@param_function(unit=Unit.CURRENCY.PER_YEAR)\n",
+    "@param_function(unit=TTSIMUnit.CURRENCY.PER_YEAR)\n",
     "def kinderfreibetrag_pro_kind_y(\n",
     "    parameter_kinderfreibetrag: dict[str, float],\n",
     "    kinderzuschlag__parameter_existenzminimum: dict[str, dict[str, float]],\n",
@@ -966,6 +965,10 @@
     "`PolicyFunction`s are usually written to operate on rows of the input data. They can\n",
     "take any parameter or other `ColumnObject` as inputs.\n",
     "\n",
+    "Like parameters, every `ColumnObject` declares a `unit` (GEP 10), so a function you\n",
+    "add or replace must declare one too. Functions are typically currency-agnostic —\n",
+    "they use `TTSIMUnit.CURRENCY.PER_YEAR`, not a concrete currency like `TTSIMUnit.EUR.PER_YEAR`.\n",
+    "\n",
     "**Note**: Some `PolicyFunction`s operate on columns of input data. Their decorator will\n",
     "contain the term `vectorization_strategy=\"not_required\"`.\n",
     "\n",
@@ -975,7 +978,7 @@
     "This is the original function:\n",
     "\n",
     "```python\n",
-    "@policy_function(unit=Unit.CURRENCY.PER_YEAR)\n",
+    "@policy_function(unit=TTSIMUnit.CURRENCY.PER_YEAR)\n",
     "def kinderfreibetrag_y(\n",
     "    anzahl_kinderfreibeträge: int,\n",
     "    kinderfreibetrag_pro_kind_y: float,\n",
@@ -1005,18 +1008,18 @@
     ")\n",
     "\n",
     "# Step 2: Create a new parameter `min_anzahl_kinder_für_kinderfreibetrag`\n",
-    "from gettsim.tt import ScalarParam, Unit\n",
+    "from gettsim.tt import ScalarParam, TTSIMUnit\n",
     "\n",
     "min_anzahl_kinder_für_kinderfreibetrag = ScalarParam(\n",
-    "    value=2, unit=Unit.PERSON_COUNT.PER_FG\n",
+    "    value=2, unit=TTSIMUnit.PERSON_COUNT\n",
     ")\n",
     "\n",
     "# Step 3: Create a new `PolicyFunction` that modifies the tax deduction for children\n",
     "# based on the new parameter\n",
     "from gettsim.tt import policy_function\n",
     "\n",
     "\n",
-    "@policy_function(unit=Unit.CURRENCY.PER_YEAR)\n",
+    "@policy_function(unit=TTSIMUnit.CURRENCY.PER_YEAR)\n",
     "def kinderfreibetrag_y(\n",
     "    anzahl_kinderfreibeträge: int,\n",
     "    kinderfreibetrag_pro_kind_y: float,\n",

docs/tutorials/simple_example.ipynb

@@ -394,7 +394,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We get the current `value` of the `ScalarParam` out. We then inject a new `ScalarParam` object into the same place of `policy_environment`, carrying over the unit of the parameter we replace — every parameter must declare one (GEP 10), and changing a value must not change its unit."
+    "We get the current `value` of the `ScalarParam` out. We then inject a new `ScalarParam` object into the same place of `policy_environment`, carrying over the unit of the parameter we replace — every parameter must declare one (GEP 10)."
    ]
   },
   {