Skip to content

Commit b9d1032

Browse files
committed
Add explainer for not applicable inputs.
1 parent cdd7ba8 commit b9d1032

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/tutorials/simple_example.ipynb

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,20 @@
288288
"# Edit the leafs in the template and then read it back in\n",
289289
"with PATH_FOR_TEMPLATE.open(\"r\") as f:\n",
290290
" MAPPER = yaml.safe_load(f)\n",
291-
"```"
291+
"```\n",
292+
"\n",
293+
"Some inputs in the mapper may not be directly relevant to an individual’s current\n",
294+
"situation, as they depend on future circumstances or choices. For example, variables\n",
295+
"such as `jahr_renteneintritt` or `alter_beginn_leistungsbezug_sonstige_private_vorsorge`\n",
296+
"are only meaningful for individuals who actually receive pensions. However, since\n",
297+
"GETTSIM represents the tax and transfer system as a static directed acyclic graph (DAG),\n",
298+
"these inputs are still required, even when they are not applicable. \n",
299+
"\n",
300+
"In such cases, you can safely assign a reasonable default value. The exact number\n",
301+
"usually does not matter (as long as the corresponding benefit, such as the pension, is\n",
302+
"set to zero), but it must still be a valid input. For instance, `jahr_renteneintritt`\n",
303+
"should not be set to 0 or `None`, but any plausible year value will work. \n",
304+
"\n"
292305
]
293306
},
294307
{

0 commit comments

Comments
 (0)