GEP 10: annotate the taxes and transfers system with units (#1192)

.pre-commit-config.yaml

@@ -89,7 +89,7 @@ repos:
         # ty pin in sync with the `ty-pre-commit` rev above.
         language: python
         additional_dependencies:
-          - ty==0.0.49
+          - ty==0.0.52
         entry: ty check --python .pixi/envs/py314-jax
         pass_filenames: false
         always_run: true

AGENTS.md

@@ -27,8 +27,8 @@ pixi run -e py314-jax tests src/gettsim/tests_germany/test_policy_cases.py
 pixi run -e py314-jax tests -k "kindergeld"
 
 # Type checking (runs as the ty / ty-jax pre-commit hooks)
-prek run ty --all-files
-prek run ty-jax --all-files
+pixi run prek run ty --all-files
+pixi run prek run ty-jax --all-files
 
 # Quality checks (linting, formatting)
 pixi run prek run --all-files

CHANGES.md

@@ -15,6 +15,19 @@ All releases are available on [Anaconda.org](https://anaconda.org/conda-forge/ge
 
 ## Unreleased
 
+- {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`,
+  `vorsorge_krankenversicherungsbeiträge_option_a` and `_option_b` all gain `_y`;
+  `betrag_versicherter_regulärer_beitragssatz`,
+  `lohnersatzanteil_einkommen_untere_grenze` and `_obere_grenze`,
+  `mean_entgeltpunkte_zuschlag`, `minijobgrenze`, `rentenwert` and the Kinderzuschlag
+  `satz` all gain `_m`. Two lose a suffix they should never have had, being shares
+  rather than flows: `anteil_steuerfälliger_einnahmen_y` and
+  `mehrbedarfsanteil_alleinerziehend_m`. `gesamteinkommen_y` becomes
+  `gesamteinkommen_y_sn`, 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,6 +1,25 @@
 {
-  "$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": "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]*(?:_(?!PER_)[A-Z0-9]+)*(?:_PER_(?:SQUARE_METER|HOURS))?(?:_PER_(?:YEAR|QUARTER|MONTH|WEEK|DAY))?(?:_PER_(?:HH|EHE|FG|BG|EG|WTHH|SN))?$"
+    },
+    "unitDeclaration": {
+      "oneOf": [
+        { "$ref": "#/definitions/unitToken" },
+        {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/definitions/unitDeclaration" }
+        }
+      ]
+    },
+    "axisUnitDeclaration": {
+      "$ref": "#/definitions/unitToken"
+    }
+  },
   "type": "object",
   "patternProperties": {
     "^[a-zA-Z0-9äöüßÄÖÜ_]+$": {
@@ -25,19 +44,13 @@
           "additionalProperties": false
         },
         "unit": {
-          "type": ["string", "null"],
-          "enum": [
-            "Euros",
-            "DM",
-            "Share",
-            "Percent",
-            "Years",
-            "Months",
-            "Hours",
-            "Square Meters",
-            "Euros / Square Meter",
-            null
-          ]
+          "$ref": "#/definitions/unitDeclaration"
+        },
+        "input_unit": {
+          "$ref": "#/definitions/axisUnitDeclaration"
+        },
+        "output_unit": {
+          "$ref": "#/definitions/axisUnitDeclaration"
         },
         "type": {
           "type": "string",
@@ -55,10 +68,6 @@
             "require_converter"
           ]
         },
-        "reference_period": {
-          "type": ["string", "null"],
-          "enum": ["Year", "Quarter", "Month", "Week", "Day", "Hour", null]
-        },
         "add_jahresanfang": {"type": "boolean"}
       },
       "patternProperties": {
@@ -71,9 +80,30 @@
                 { "type": "string", "enum": ["inf", "-inf"] }
               ]
             },
+            "intervals": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "interval": { "type": "string" }
+                },
+                "required": ["interval"],
+                "additionalProperties": true
+              }
+            },
+            "unit": {
+              "$ref": "#/definitions/unitDeclaration"
+            },
+            "input_unit": {
+              "$ref": "#/definitions/axisUnitDeclaration"
+            },
+            "output_unit": {
+              "$ref": "#/definitions/axisUnitDeclaration"
+            },
             "reference": { "type": "string" },
             "note": { "type": "string" },
-            "deviation_from": { "type": "string" }
+            "deviation_from": { "type": "string" },
+            "updates_previous": { "type": "boolean" }
           },
           "additionalProperties": true
         }
@@ -83,11 +113,68 @@
         { "required": [
           "name",
           "description",
-          "unit",
-          "reference_period",
           "type"
         ]
       },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "enum": [
+                  "piecewise_constant",
+                  "piecewise_linear",
+                  "piecewise_quadratic",
+                  "piecewise_cubic",
+                  "consecutive_int_lookup_table",
+                  "sparse_to_consecutive_int_lookup_table",
+                  "month_based_phase_inout_of_age_thresholds",
+                  "year_based_phase_inout_of_age_thresholds"
+                ]
+              }
+            }
+          },
+          "then": {
+            "required": ["input_unit", "output_unit"],
+            "not": { "required": ["unit"] }
+          },
+          "else": {
+            "if": {
+              "properties": { "type": { "const": "require_converter" } }
+            },
+            "then": {
+              "oneOf": [
+                {
+                  "required": ["unit"],
+                  "allOf": [
+                    { "not": { "required": ["input_unit"] } },
+                    { "not": { "required": ["output_unit"] } }
+                  ]
+                },
+                {
+                  "required": ["input_unit", "output_unit"],
+                  "not": { "required": ["unit"] }
+                }
+              ]
+            },
+            "else": {
+              "allOf": [
+                { "not": { "required": ["input_unit"] } },
+                { "not": { "required": ["output_unit"] } }
+              ]
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": { "type": { "const": "scalar" } },
+            "required": ["type"]
+          },
+          "then": {
+            "properties": {
+              "unit": { "$ref": "#/definitions/unitToken" }
+            }
+          }
+        },
         {
           "minProperties": 1,
           "patternProperties": {