From c458f77accb6ae6318c3ad7a6fed108294fbeb1a Mon Sep 17 00:00:00 2001
From: nikhilwoodruff <35577657+nikhilwoodruff@users.noreply.github.com>
Date: Tue, 14 May 2024 15:28:59 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20c80c0?=
 =?UTF-8?q?ad43fc527c96372718d00491b487c43ce8e=20=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 _downloads/621e2c7711e8623173875c33222eddb6/changelog.yaml | 5 +++++
 _sources/usage/parameters.md                               | 5 +++--
 searchindex.js                                             | 2 +-
 usage/parameters.html                                      | 7 ++++---
 4 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/_downloads/621e2c7711e8623173875c33222eddb6/changelog.yaml b/_downloads/621e2c7711e8623173875c33222eddb6/changelog.yaml
index e5c06c278..697e8f6d5 100644
--- a/_downloads/621e2c7711e8623173875c33222eddb6/changelog.yaml
+++ b/_downloads/621e2c7711e8623173875c33222eddb6/changelog.yaml
@@ -562,3 +562,8 @@
     - Replaced unsafe numpy-Python comparison with use of numpy dtype to convert byte-string
       arrays to Unicode ones within enums
   date: 2024-05-13 16:26:53
+- bump: patch
+  changes:
+    fixed:
+    - Remove name metadata tag in docs.
+  date: 2024-05-14 15:27:27
diff --git a/_sources/usage/parameters.md b/_sources/usage/parameters.md
index eba3b959b..a7a257002 100644
--- a/_sources/usage/parameters.md
+++ b/_sources/usage/parameters.md
@@ -46,10 +46,11 @@ Each parameter (or parameter node) can also set **metadata**: data that describe
 Here's an example metadata specification for the `child_benefit.basic.amount` parameter:
 
 ```yaml
+description: The UK provides this Child Benefit per child.
+
 metadata:
-    name: child_benefit
     label: Child Benefit
-    description: The amount of Child Benefit paid per child.
+    period: year
     unit: currency-GBP
     reference: 
         - label: GOV.UK | Child Benefit
diff --git a/searchindex.js b/searchindex.js
index faafb3ae3..8f9793426 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["contributing/intro", "intro", "python_api/commons", "python_api/country_template", "python_api/data", "python_api/data_storage", "python_api/entities", "python_api/enums", "python_api/errors", "python_api/experimental", "python_api/extension_template", "python_api/holders", "python_api/parameters", "python_api/periods", "python_api/populations", "python_api/projectors", "python_api/reforms", "python_api/scripts", "python_api/simulations", "python_api/taxbenefitsystems", "python_api/taxscales", "python_api/tools", "python_api/tracers", "python_api/types", "python_api/variables", "python_api/warnings", "usage/charts", "usage/cli", "usage/country", "usage/datasets", "usage/parameters", "usage/reforms", "usage/simulation"], "filenames": ["contributing/intro.md", "intro.md", "python_api/commons.md", "python_api/country_template.md", "python_api/data.md", "python_api/data_storage.md", "python_api/entities.md", "python_api/enums.md", "python_api/errors.md", "python_api/experimental.md", "python_api/extension_template.md", "python_api/holders.md", "python_api/parameters.md", "python_api/periods.md", "python_api/populations.md", "python_api/projectors.md", "python_api/reforms.md", "python_api/scripts.md", "python_api/simulations.md", "python_api/taxbenefitsystems.md", "python_api/taxscales.md", "python_api/tools.md", "python_api/tracers.md", "python_api/types.md", "python_api/variables.md", "python_api/warnings.md", "usage/charts.ipynb", "usage/cli.md", "usage/country.ipynb", "usage/datasets.ipynb", "usage/parameters.md", "usage/reforms.md", "usage/simulation.ipynb"], "titles": ["How to contribute", "Introduction", "Commons", "Country template", "Data", "Data storage", "Entities", "Enums", "Errors", "Experimental features", "Extension template", "Holders", "Parameters", "Periods", "Populations", "Projectors", "Reforms", "Scripts", "Simulations", "Tax-benefit systems", "Tax scales", "Tools", "Tracers", "Types", "Variables", "Warnings", "Charts", "Using the command-line interface", "Creating a country package", "Writing datasets", "Writing parameters", "Writing reforms", "Simulating policy"], "terms": {"ani": [0, 1, 2, 5, 6, 10, 11, 12, 14, 16, 18, 20, 24, 27, 30, 32], "all": [0, 4, 11, 12, 13, 14, 16, 18, 19, 20, 21, 27, 28, 30, 31], "ar": [0, 1, 2, 5, 6, 7, 8, 11, 12, 14, 18, 19, 20, 22, 24, 28, 30, 31], "welcom": 0, "thi": [0, 1, 2, 4, 6, 11, 12, 14, 16, 18, 19, 22, 24, 27, 28, 29, 30, 31, 32], "project": [0, 14], "you": [0, 4, 18, 28, 31, 32], "can": [0, 1, 4, 6, 7, 11, 12, 13, 16, 18, 19, 21, 24, 28, 29, 30, 31, 32], "help": 0, "file": [0, 3, 4, 8, 12, 19, 21, 24, 27, 28, 30], "issu": 0, "tell": 0, "us": [0, 1, 2, 3, 4, 5, 7, 10, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32], "about": [0, 11, 15, 18, 24, 30], "bug": 0, "ve": 0, "found": [0, 8, 19], "featur": [0, 4], "d": [0, 27], "like": [0, 4], "see": [0, 14, 19, 21, 24, 26, 29, 32], "fix": [0, 30], "an": [0, 2, 4, 6, 7, 8, 10, 11, 12, 13, 14, 16, 18, 19, 24, 27, 28, 30, 31, 32], "someon": 0, "els": 0, "ha": [0, 4, 8, 11, 12, 14, 18, 19, 24, 27, 28], "If": [0, 4, 11, 12, 14, 18, 19, 20, 21, 22, 24, 27, 30, 31, 32], "one": [0, 2, 4, 8, 18, 19, 20, 32], "maintain": [0, 1, 30], "primarili": 0, "nikhilwoodruff": 0, "respond": 0, "within": [0, 2, 14, 20], "least": 0, "week": 0, "don": [0, 10, 14, 32], "t": [0, 2, 8, 9, 10, 14, 18, 24, 28, 30, 32], "hear": 0, "back": 0, "feel": 0, "free": [0, 7, 24], "ping": 0, "befor": [0, 24, 30], "send": 0, "out": 0, "make": [0, 2, 16, 19], "sure": [0, 32], "add": [0, 12, 16, 18, 19, 24, 29, 30, 31], "descript": [0, 6, 12, 18, 24, 30, 32], "your": [0, 3, 10, 27], "chang": [0, 6, 12, 18, 24, 26, 30, 31, 32], "changelog_entri": 0, "yaml": [0, 3, 12, 16, 19, 21, 27, 30], "For": [0, 7, 13, 15, 20, 24, 30, 31, 32], "exampl": [0, 2, 7, 11, 13, 14, 15, 16, 18, 19, 22, 26, 28, 30, 31, 32], "bump": 0, "patch": 0, "caus": 0, "window": 0, "test": [0, 17, 21, 28, 29], "fail": 0, "find": [0, 32], "more": [0, 11, 18, 21, 22, 24, 26], "note": [0, 14], "do": [0, 27, 29, 31, 32], "need": [0, 4, 27, 28, 29, 31, 32], "date": [0, 13, 24, 30], "field": [0, 24, 30], "That": 0, "automat": [0, 3, 4, 19, 24, 27], "popul": [0, 11, 15, 18, 22, 28, 29], "also": [0, 1, 19, 28, 29, 30, 31, 32], "should": [0, 4, 12, 16, 18, 19, 28, 30, 31, 32], "run": [0, 6, 11, 18, 21, 27], "yourself": 0, "our": [0, 11, 32], "github": [0, 19], "workflow": 0, "part": [0, 29], "build": [0, 1, 18], "process": [0, 1, 24, 30], "each": [0, 1, 2, 11, 18, 22, 24, 28, 30, 32], "close": 0, "isn": 0, "complet": [0, 4], "address": 0, "pleas": 0, "have": [0, 1, 7, 10, 11, 14, 19, 24, 30, 32], "sens": 0, "layperson": 0, "re": [0, 18, 32], "describ": [0, 3, 18, 19, 24, 29, 30], "what": [0, 14, 32], "ad": [0, 6, 8, 19, 24, 28, 30], "why": 0, "write": [0, 4, 18, 21, 27], "without": [0, 11, 12, 18, 27], "pass": [0, 18, 21, 27, 32], "cover": 0, "sometim": 0, "necessari": 0, "document": [0, 1, 11, 18, 24, 30], "doubt": 0, "err": 0, "side": 0, "includ": [0, 1, 11, 17, 18, 21, 29, 31, 32], "action": [0, 27], "ask": [0, 15, 16, 19, 32], "policyengin": [1, 3, 16, 19, 24, 26, 27, 29, 31, 32], "core": [1, 3, 4, 24, 26, 27, 28, 29, 32], "open": [1, 4], "sourc": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 25, 30], "python": [1, 3, 17, 18, 19, 24, 27, 28, 30, 31, 32], "packag": [1, 10, 18, 19, 27, 30, 31, 32], "power": [1, 17, 26], "s": [1, 4, 6, 11, 15, 18, 19, 28, 29, 30, 31, 32], "tax": [1, 3, 8, 12, 16, 18, 21, 31, 32], "benefit": [1, 3, 8, 15, 18, 21, 30, 31], "microsimul": [1, 4, 26, 28, 29, 32], "model": [1, 3, 4, 10, 18, 19, 26, 29, 32], "It": [1, 3, 4, 19, 31], "fork": [1, 4], "openfisca": [1, 4, 19, 24, 27], "develop": 1, "doe": [1, 4, 14, 18, 19, 21, 28, 31], "simul": [1, 4, 5, 8, 11, 14, 21, 22, 24, 28, 29], "specif": [1, 8, 10, 11, 25, 28, 29], "polici": [1, 3, 18, 19, 28, 29], "instead": [1, 14, 28, 31], "gener": [1, 4, 12, 19, 24, 26, 27, 28, 29, 30, 31, 32], "framework": 1, "current": [1, 12, 19], "uk": [1, 26, 30], "which": [1, 4, 6, 7, 10, 11, 12, 14, 16, 18, 22, 24, 27, 28, 30, 31, 32], "defin": [1, 3, 4, 6, 8, 10, 12, 13, 14, 18, 19, 24, 28, 29, 30, 31, 32], "custom": [1, 25], "logic": [1, 18, 19, 28, 29], "paramet": [1, 2, 3, 4, 6, 7, 8, 11, 16, 18, 19, 20, 21, 22, 24, 26, 28], "data": [1, 7, 11, 12, 18, 19, 21, 24, 26, 28, 29, 30, 32], "requir": [1, 4, 15, 18], "system": [1, 3, 8, 18, 21, 31], "respect": [1, 14, 18, 19], "The": [1, 2, 3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32], "countri": [1, 10, 16, 18, 19, 27, 29, 30, 31, 32], "provid": [1, 4, 8, 14, 18, 26, 27, 32], "A": [1, 2, 3, 4, 6, 11, 12, 13, 16, 18, 19, 21, 24, 29, 30], "set": [1, 8, 11, 12, 14, 18, 19, 20, 22, 24, 25, 26, 27, 28, 30], "entiti": [1, 3, 11, 14, 15, 18, 19, 24, 28, 30, 31, 32], "type": [1, 2, 4, 6, 7, 11, 12, 16, 18, 19, 20, 22, 24, 28, 30], "e": [1, 4, 6, 11, 12, 14, 18, 19, 27, 30, 32], "g": [1, 4, 6, 11, 12, 14, 19, 32], "person": [1, 6, 11, 14, 15, 18, 19, 24, 26, 30, 31, 32], "flat_tax": 1, "rate": [1, 12, 20, 26, 30], "global": 1, "point": [1, 3, 13, 19, 30], "differ": [1, 3, 6, 10, 11, 19, 26, 29, 30], "valu": [1, 2, 4, 5, 7, 8, 11, 12, 13, 14, 16, 18, 19, 20, 22, 24, 26, 27, 28, 31, 32], "time": [1, 4, 11, 12, 13, 30, 32], "period": [1, 3, 4, 5, 7, 8, 11, 12, 14, 16, 18, 19, 22, 24, 26, 29, 31, 32], "variabl": [1, 3, 4, 8, 11, 14, 16, 18, 19, 20, 22, 23, 27, 28, 30, 32], "income_tax": [1, 12, 26, 30, 32], "properti": [1, 4, 11, 13, 14, 18], "depend": [1, 2, 24], "other": [1, 4, 6, 12, 13, 24, 25, 28, 32], "enabl": [1, 28], "user": [1, 28, 32], "calcul": [1, 3, 5, 6, 11, 18, 19, 22, 24, 26, 27, 28, 32], "trace": [1, 18, 27], "comput": [1, 11, 18, 19, 20, 22, 24, 32], "tree": [1, 3, 12, 19, 28, 30, 31], "mani": 1, "helper": [1, 6, 11, 12, 13], "function": [1, 2, 4, 6, 11, 12, 14, 16, 17, 18, 19, 20, 21, 24, 26, 29, 30, 31], "design": 1, "simplifi": 1, "policyengine_cor": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32], "modul": [2, 3, 4, 5, 6, 10, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 28], "contain": [2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 30], "number": [2, 13, 14, 21, 24], "class": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32], "throughout": 2, "rest": 2, "librari": 2, "input": [2, 3, 7, 8, 11, 18, 19, 20, 24, 32], "ndarrai": [2, 7, 14, 18, 20], "none": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 29], "float": [2, 5, 9, 11, 12, 14, 18, 20, 22, 24, 30, 31], "threshold": [2, 12, 20, 30], "union": [2, 4, 5, 7, 11, 12, 14, 18, 30], "object": [2, 3, 4, 5, 6, 9, 11, 12, 14, 16, 18, 19, 22, 24, 30, 31], "sequenc": [2, 3, 4, 18, 19], "choic": [2, 27], "base": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 18, 19, 20, 22, 24, 25, 30], "from": [2, 3, 4, 7, 10, 12, 13, 16, 18, 19, 20, 21, 24, 26, 28, 29, 31, 32], "list": [2, 3, 4, 5, 6, 9, 11, 12, 13, 14, 18, 19, 21, 22, 24, 26, 27, 28, 30, 32], "select": 2, "choos": 2, "possibl": [2, 24, 27, 30], "return": [2, 4, 7, 11, 12, 13, 14, 16, 18, 19, 20, 21, 24, 25, 26, 31, 32], "chosen": 2, "numpi": [2, 7, 20, 24], "rais": [2, 4, 8, 18, 19, 21, 25], "assertionerror": [2, 21], "when": [2, 3, 8, 18, 19, 20, 24, 25, 30], "c": [2, 27], "either": [2, 4, 13, 30], "1": [2, 7, 13, 14, 18, 20, 24, 26, 29, 30, 32], "arrai": [2, 4, 7, 11, 14, 18, 20, 22, 32], "4": [2, 13, 14, 18, 30, 32], "5": [2, 18, 20, 30, 32], "6": [2, 30, 32], "7": [2, 6, 30], "8": [2, 11, 14, 26], "10": [2, 11, 13, 18, 20, 26, 32], "15": [2, 32], "20": [2, 26, 30], "str": [2, 3, 4, 5, 6, 9, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 24, 30], "unicod": 2, "concaten": 2, "two": [2, 5, 8, 14, 29, 30], "anoth": [2, 12, 18, 20, 24, 32], "2": [2, 7, 11, 13, 14, 19, 26, 29, 30, 32], "this1": 2, "0": [2, 6, 7, 14, 16, 18, 19, 20, 22, 24, 26, 29, 32], "that2": 2, "condit": [2, 14], "value_by_condit": 2, "dict": [2, 4, 5, 11, 12, 16, 18, 19, 21, 24, 28, 30, 32], "mimick": 2, "statement": 2, "given": [2, 4, 11, 12, 13, 14, 18, 19, 20, 24, 27, 29, 30, 32], "same": [2, 8, 16, 19, 28, 29, 30, 31, 32], "size": [2, 13], "replac": [2, 12, 16, 19, 24, 28], "item": [2, 7], "match": [2, 8, 11, 18, 20, 24], "empti": 2, "80": 2, "90": 2, "country_templ": [3, 18, 28, 29, 32], "intend": [3, 10], "start": [3, 12, 13, 22, 24, 26, 31], "new": [3, 4, 9, 10, 11, 12, 13, 16, 19, 20, 28, 31], "To": [3, 10, 11, 18, 27, 28, 29, 30, 31, 32], "creat": [3, 4, 10, 13, 16, 18, 26], "simpli": [3, 10, 19], "copi": [3, 10, 11, 18, 28], "content": [3, 10], "repo": [3, 10, 18, 30], "renam": [3, 7, 10], "folder": [3, 10, 18, 28, 30], "name": [3, 4, 8, 10, 12, 16, 18, 19, 20, 22, 24, 29, 30, 31, 32], "remov": [3, 4, 9, 10, 11, 12, 27, 31], "starter": [3, 10], "code": [3, 8, 10, 24, 26, 27, 28, 30, 32], "option": [3, 4, 5, 6, 7, 9, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 27, 31, 32], "reform": [3, 18, 19, 24, 26, 27, 28], "taxbenefitsystem": [3, 8, 16, 18, 21, 28], "auto_carry_over_input_vari": [3, 19, 28], "bool": [3, 4, 5, 6, 11, 12, 13, 14, 18, 19, 20, 24, 30], "fals": [3, 4, 5, 6, 11, 12, 14, 18, 19, 20, 22, 24, 27, 28, 30], "whether": [3, 4, 18, 19, 24, 30], "carri": [3, 19], "over": [3, 12, 18, 19, 30, 31], "group_ent": [3, 6], "groupent": [3, 14], "modelled_polici": [3, 19], "posixpath": 3, "home": 3, "runner": [3, 17], "work": [3, 32], "filepath": [3, 19], "metadata": [3, 4, 12, 19, 24, 28, 29], "parameters_dir": [3, 19, 28], "directori": [3, 11, 12, 19, 21, 27, 28], "variables_dir": [3, 19, 28], "origin": [4, 11, 18], "standardis": [4, 29], "definit": [4, 7, 8, 11, 16, 18, 19, 24, 25, 28, 32], "instanti": [4, 12, 28, 29], "nation": 4, "lower": [4, 26], "repres": [4, 6, 7, 11, 18, 19, 20, 22, 23, 30, 32], "directli": [4, 28], "indirectli": 4, "common": [4, 29, 32], "storag": [4, 29], "load": [4, 12, 19, 27, 29, 32], "tabl": [4, 27], "time_period_arrai": [4, 29], "data_format": [4, 29], "format": [4, 13, 19, 24, 29, 32], "store": [4, 5, 11, 18, 19, 24, 29, 30], "collect": [4, 30], "per": [4, 30], "datafram": [4, 18, 26], "download": [4, 27, 29], "url": [4, 29, 30], "path": [4, 8, 19, 21, 24, 27, 28], "exist": [4, 10, 14, 18, 19, 31, 32], "check": [4, 11, 12, 14, 18, 28, 32], "file_path": [4, 12, 16, 19], "year": [4, 13, 24, 26, 29, 31], "implement": [4, 12, 16, 28, 30], "method": [4, 11, 14, 16, 18, 29, 30, 31, 32], "notimplementederror": 4, "been": [4, 8, 11, 12, 18, 19, 24], "overriden": 4, "label": [4, 6, 24, 29, 30, 31], "log": [4, 22, 28], "kei": [4, 6, 13, 18, 24, 32], "dictionari": [4, 13, 16, 18, 19, 24, 32], "mode": [4, 22], "r": [4, 18, 27], "hdfstore": 4, "h5": 4, "reader": 4, "access": [4, 12], "2022": [4, 29, 32], "default": [4, 5, 11, 14, 18, 19, 22, 24, 26, 27, 28, 29, 31, 32], "h5py": 4, "np": [4, 7, 18], "pd": [4, 18], "load_dataset": 4, "disk": [4, 5, 25], "filenam": 4, "save": 4, "overwrit": [4, 18], "save_dataset": 4, "example_data": 4, "employment_incom": 4, "25000": 4, "30000": 4, "store_fil": 4, "move": [4, 30], "time_period": [4, 32], "enter": 4, "correct": 4, "data_storag": 5, "handl": [5, 13, 18, 32], "in_memory_storag": 5, "is_etern": 5, "low": 5, "level": 5, "respons": [5, 28, 32], "retriev": 5, "vector": [5, 12, 14, 22], "memori": [5, 11, 18], "clone": [5, 11, 12, 14, 18], "delet": [5, 18], "branch_nam": [5, 11, 22], "get": [5, 11, 14, 18, 19, 24], "_supportsarrai": [5, 11, 12, 14, 18], "dtype": [5, 7, 11, 12, 14, 18, 24, 32], "_nestedsequ": [5, 11, 12, 14, 18], "int": [5, 7, 11, 12, 13, 14, 18, 20, 24, 29, 30], "complex": [5, 11, 12, 14, 18], "byte": [5, 11, 12, 14, 18], "get_known_branch_period": [5, 11], "get_known_period": [5, 11, 18], "get_memory_usag": [5, 11, 14, 18], "put": 5, "on_disk_storag": 5, "storage_dir": 5, "preserve_storage_dir": 5, "restor": [5, 21], "how": [6, 12, 18, 28, 29, 31, 32], "group": [6, 14, 18, 32], "plural": [6, 18, 32], "doc": [6, 24, 32], "household": [6, 7, 14, 18, 24, 29], "etc": [6, 11], "check_role_valid": 6, "check_variable_defined_for_ent": 6, "variable_nam": [6, 8, 14, 18, 19, 31, 32], "get_vari": [6, 19], "check_exist": [6, 19], "set_tax_benefit_system": 6, "tax_benefit_system": [6, 8, 18, 19, 21, 24], "containing_ent": 6, "sever": [6, 24], "identifi": [6, 7, 16, 30], "pluralis": 6, "summari": 6, "full": [6, 30, 32], "whose": [6, 7, 11, 14, 18, 20, 30], "member": [6, 14, 32], "guarante": 6, "superset": 6, "version": [6, 9, 19], "35": 6, "allow": [6, 12, 15, 24], "entir": [6, 22, 24, 27, 30], "relat": [6, 15, 28, 30], "between": [6, 11, 26, 30], "instanc": [6, 7, 11, 12, 13, 15, 16, 18, 19, 20, 24], "is_person": 6, "indexed_enum": 7, "enumer": 7, "specifi": [7, 14, 18, 27, 29, 31, 32], "categor": [7, 24], "enum34": 7, "index": [7, 12, 18, 19, 24, 26, 30], "classmethod": [7, 24], "encod": 7, "string": [7, 18, 24], "string_arrai": 7, "item_1": 7, "item_2": 7, "item_3": 7, "encoded_arrai": 7, "myenum": 7, "3": [7, 13, 14, 22, 30, 32], "int8": 7, "item_arrai": 7, "enum_arrai": 7, "input_arrai": 7, "int_": [7, 20], "possible_valu": [7, 24], "subclass": [7, 16, 19, 29], "improv": 7, "perform": [7, 27], "decod": [7, 18], "object_": 7, "correspond": [7, 24], "self": [7, 13, 16, 19, 25, 26, 29, 30, 31], "housing_occupancy_statu": 7, "housingoccupancystatu": 7, "free_lodg": 7, "lodger": 7, "decode_to_str": 7, "str_": 7, "nan_creation_error": 8, "except": [8, 19, 25], "parameter_not_found_error": 8, "instant_str": [8, 12], "attributeerror": 8, "parameter_parsing_error": 8, "messag": 8, "traceback": [8, 32], "cannot": [8, 32], "pars": 8, "period_mismatch_error": 8, "definition_period": [8, 11, 18, 24, 31], "valueerror": [8, 18], "tri": 8, "doesn": 8, "its": [8, 11, 14, 19, 24, 30, 31], "situation_parsing_error": 8, "situat": [8, 18, 28, 32], "spiral_error": 8, "variable_name_conflict_error": 8, "variable_not_found_error": 8, "queri": 8, "hous": 9, "aren": 9, "fulli": [9, 18], "stabl": 9, "yet": 9, "mai": [9, 11, 18], "futur": 9, "memory_config": [9, 18], "max_memory_occup": 9, "priority_vari": 9, "variables_to_drop": 9, "extension_templ": 10, "plugin": 10, "rather": 10, "than": [10, 19, 26, 30], "standalon": 10, "initialis": [10, 18], "unlik": [10, 18], "must": [10, 12, 14, 16, 19, 24, 28, 29, 30, 31], "countrytaxbenefitsystem": [10, 18, 28], "keep": [11, 20], "track": [11, 22], "after": [11, 30], "thei": [11, 30], "just": [11, 18, 29, 32], "enough": [11, 18], "abl": [11, 12, 18, 29, 31], "modifi": [11, 12, 16, 18], "create_disk_storag": 11, "preserv": 11, "ondiskstorag": 11, "default_arrai": 11, "appropri": 11, "length": [11, 24], "fill": 11, "delete_arrai": [11, 18], "known": [11, 18], "onli": [11, 14, 19, 22, 24, 27, 32], "2017": [11, 13], "01": [11, 12, 13, 14, 24, 26, 29, 30, 31, 32], "07": 11, "would": [11, 32], "get_arrai": [11, 18], "tupl": [11, 13, 18, 24], "virtual": [11, 18], "usag": [11, 18, 24, 27, 32], "nb_arrai": 11, "12": [11, 13, 18, 26], "nb_cells_by_arrai": 11, "100": [11, 20, 22, 29, 31], "There": [11, 18], "cell_siz": 11, "take": [11, 16, 19, 24, 31], "8b": 11, "float64": [11, 20], "64": 11, "total_nb_byt": 11, "10400": 11, "4kb": 11, "nb_request": 11, "24": [11, 30], "nb_requests_by_arrai": 11, "averag": [11, 20, 22], "request": [11, 12, 19], "twice": 11, "put_in_cach": 11, "set_input": [11, 18, 24], "14": [11, 18], "2018": [11, 14, 18], "04": [11, 18, 30], "accept": [11, 18], "read": [11, 18], "declar": [11, 32], "attribut": [11, 18, 19, 24], "In": [11, 12, 16, 31], "case": [11, 12, 18, 28, 29, 30, 31, 32], "larger": [11, 18], "appli": [11, 12, 16, 19, 20, 26, 27, 28, 30, 31], "subperiod": 11, "divid": 11, "mainli": 12, "revolv": 12, "around": 12, "instant": [12, 18, 19, 26, 30, 31], "pattern": 12, "evalu": [12, 30], "legisl": [12, 16, 19, 24, 30], "values_list": 12, "revers": [12, 14], "chronolog": 12, "order": [12, 14], "some_tax": [12, 16], "some_param": [12, 16], "wa": 12, "2015": [12, 13], "550": 12, "2016": [12, 18], "600": 12, "incom": [12, 26, 32], "salari": [12, 14, 18, 29, 32], "refer": [12, 24, 29], "http": [12, 19, 24, 30], "gov": [12, 26, 30], "get_descend": 12, "mark_as_modifi": 12, "updat": [12, 16, 19, 26, 31], "stop": [12, 13, 26, 31], "where": [12, 13, 18, 24, 30], "parameter_nod": 12, "directory_path": 12, "node": [12, 20], "add_child": [12, 16], "child": [12, 14, 15, 29, 30], "anyth": 12, "could": [12, 32], "interfer": 12, "oper": 12, "dot": 12, "attach_to_par": 12, "parent": [12, 14, 15, 18, 22, 29], "clear_parent_cach": 12, "iter": [12, 13, 18], "recurs": [12, 19, 21], "merg": 12, "conflict": 12, "root": 12, "parameter_at_inst": 12, "valid": [12, 24, 29], "parameter_node_at_inst": [12, 22], "child_nam": 12, "child_at_inst": 12, "parameter_scal": 12, "scale": 12, "margin": [12, 20], "propagate_unit": 12, "propagate_upr": 12, "parameter_scale_bracket": 12, "bracket": [12, 20], "static": [12, 16], "allowed_unit_kei": 12, "uprat": [12, 24, 30], "at_instant_lik": 12, "abc": [12, 20], "variou": [12, 20], "protocol": 12, "get_at_inst": 12, "vectorial_parameter_node_at_inst": 12, "housing_benefit": 12, "zipcod": 12, "build_from_nod": 12, "check_node_vectoris": 12, "cast": 12, "vectori": 12, "fanci": 12, "interv": [13, 30], "instant_": 13, "convert": 13, "2014": 13, "datetim": 13, "dai": [13, 24], "extract": [13, 18], "month": [13, 18, 24, 29], "offset": 13, "unit": [13, 20, 24], "increment": 13, "decrement": 13, "31": [13, 26], "28": 13, "2011": 13, "2012": 13, "29": [13, 26], "2013": 13, "30": [13, 26, 32], "first": [13, 18], "last": [13, 30, 32], "period_": 13, "toolbox": 13, "tripl": 13, "integ": [13, 18, 20], "sinc": 13, "true": [13, 14, 18, 19, 22, 24, 30], "count": [13, 18, 32], "365": 13, "first_dai": 13, "first_month": 13, "get_subperiod": 13, "02": [13, 30], "intersect": 13, "last_3_month": 13, "last_month": 13, "last_year": 13, "n_2": 13, "2010": 13, "size_in_dai": 13, "366": 13, "size_in_month": 13, "this_year": 13, "aka": 13, "start_inst": [13, 30], "peopl": [14, 18, 32], "check_array_compatible_with_ent": 14, "check_period_valid": 14, "empty_arrai": 14, "filled_arrai": 14, "get_hold": [14, 18], "holder": [14, 18], "get_index": 14, "id": [14, 16, 32], "get_rank": 14, "criteria": 14, "rank": 14, "accord": 14, "minimum": [14, 22], "who": [14, 32], "taken": 14, "account": 14, "ag": [14, 18, 26, 32], "32": 14, "34": 14, "is_child": 14, "has_rol": 14, "sort": 14, "so": [14, 21, 32], "eldest": 14, "role": [14, 15, 18, 32], "value_from_partn": 14, "group_popul": [14, 18], "dimens": 14, "2000": [14, 18], "1500": 14, "1800": 14, "get_rol": [14, 18], "role_nam": 14, "max": [14, 24, 27, 32], "maximum": [14, 22], "members_entity_id": 14, "members_posit": 14, "members_rol": 14, "min": [14, 27, 32], "assum": [14, 20], "1st": 14, "nb_person": [14, 18], "ordered_members_map": 14, "mask": 14, "cach": [14, 18, 24], "map": [14, 18], "value_nth_person": 14, "reduc": 14, "callabl": [14, 16, 19, 24], "neutral_el": 14, "sum": [14, 20, 26, 32], "3500": 14, "value_from_first_person": 14, "value_from_person": 14, "uniqu": 14, "result": [14, 18, 32], "n": [14, 27], "posit": [14, 18], "arbitrari": 14, "nth": 14, "formula": [15, 18, 24, 31], "question": 15, "particular": [15, 30, 32], "might": [15, 30, 32], "earn": 15, "said": 15, "famili": [15, 30], "grouppopul": [15, 18], "famil": 15, "first_person": 15, "declarant_princip": 15, "edit": 16, "baselin": [16, 18, 26], "call": [16, 19, 32], "modify_paramet": [16, 19, 26, 31], "import": [16, 18, 20, 26, 28, 29, 31, 32], "load_parameter_fil": 16, "def": [16, 26, 29, 31], "modify_my_paramet": 16, "new_paramet": 16, "reform_nam": 16, "path_to_yaml_fil": 16, "some_period": 16, "1000": 16, "myreform": 16, "add_vari": [16, 19, 31], "some_vari": 16, "update_vari": [16, 19, 31], "some_other_vari": 16, "modifier_funct": [16, 19], "country_id": 16, "inform": [16, 30], "api": [16, 28], "from_api": 16, "api_id": 16, "pair": 16, "from_dict": 16, "parameter_valu": 16, "parameternod": [16, 19, 22, 31], "modif": [16, 19], "ui": 16, "command": 17, "line": [17, 24, 32], "interfac": [17, 32], "singular": 18, "most": [18, 28, 29, 31, 32], "combin": 18, "unknown": [18, 32], "varieti": 18, "json": [18, 24, 28], "dataset": [18, 24, 27, 28, 32], "apply_reform": [18, 19], "build_from_dataset": 18, "build_from_popul": 18, "pre": 18, "map_to": [18, 26], "decode_enum": 18, "arraylik": 18, "calculate_add": 18, "calculate_datafram": 18, "calculate_divid": 18, "calculate_output": 18, "clear_macro_cach": 18, "clear": 18, "debug": 18, "clone_tax_benefit_system": 18, "create_shortcut": 18, "data_storage_dir": 18, "temporari": 18, "intermedi": 18, "satur": 18, "avail": [18, 27, 28, 29], "default_calculation_period": 18, "default_dataset": [18, 28], "default_input_period": 18, "default_rol": 18, "assign": 18, "default_tax_benefit_system": [18, 28], "default_tax_benefit_system_inst": 18, "slow": 18, "down": 18, "speed": [18, 26], "up": [18, 22, 26, 27], "individu": [18, 25], "05": [18, 30], "13": [18, 24], "int32": 18, "deriv": 18, "wrt": 18, "delta": 18, "w": 18, "differenti": 18, "infinitesim": 18, "describe_ent": 18, "extract_person": 18, "exclude_ent": 18, "state": [18, 30], "alreai": 18, "previous": [18, 19], "trigger": 18, "get_branch": 18, "branch": [18, 24], "clone_system": 18, "get_ent": 18, "associ": 18, "i": [18, 27, 30], "initi": 18, "u": 18, "get_popul": 18, "get_variable_popul": 18, "invalidate_cache_entri": 18, "invalidate_spiral_vari": 18, "is_over_dataset": 18, "built": [18, 19], "link_to_entities_inst": 18, "macro_cache_read": 18, "macro": 18, "macro_cache_writ": 18, "map_result": 18, "source_ent": 18, "target_ent": 18, "arr": 18, "target": 18, "invalid": 18, "di": 18, "aggreg": [18, 22, 27], "purge_cache_of_invalid_valu": 18, "sample_person": 18, "sampl": 18, "weight": [18, 29, 32], "use_weight": 18, "microseri": [18, 32], "microdatafram": 18, "get_weight": 18, "max_spiral_loop": 18, "memoryconfig": [18, 25], "opt_out_cach": 18, "tracer": 18, "simpletrac": 18, "simulation_build": 18, "add_default_group_ent": 18, "persons_id": 18, "add_group_ent": 18, "persons_plur": 18, "instances_json": 18, "add_parallel_axi": 18, "axi": 18, "add_perpendicular_axi": 18, "add_person_ent": 18, "add_variable_valu": 18, "instance_index": 18, "instance_id": 18, "period_str": 18, "build_default_simul": 18, "everi": 18, "build_from_dict": 18, "input_dict": 18, "build_from_ent": 18, "build_from_vari": 18, "javier": 18, "11": [18, 26], "explicit": [18, 19], "infer": 18, "structur": [18, 28, 30, 32], "12000": 18, "check_persons_to_alloc": 18, "entity_plur": 18, "person_id": [18, 29], "entity_id": 18, "role_id": 18, "persons_to_alloc": 18, "create_ent": 18, "declare_ent": 18, "entity_singular": 18, "declare_person_ent": 18, "person_singular": 18, "expand_ax": 18, "explicit_singular_ent": 18, "preprocess": 18, "singl": [18, 20, 30, 32], "shortcut": 18, "finalize_variables_init": 18, "get_count": 18, "entity_nam": 18, "get_id": 18, "get_input": 18, "get_membership": 18, "get_variable_ent": 18, "init_variable_valu": 18, "instance_object": 18, "join_with_person": 18, "persons_group_assign": 18, "raise_period_mismatch": 18, "register_vari": 18, "set_default_period": 18, "everyon": [19, 32], "some": 19, "add_modelled_policy_metadata": 19, "error": [19, 27, 31], "variablenameconflicterror": 19, "add_variable_metadata_from_fold": 19, "readm": 19, "md": 19, "add_variables_from_directori": 19, "explor": [19, 21], "add_variables_from_fil": 19, "reform_path": 19, "mutat": 19, "installed_packag": 19, "sub_modul": 19, "openfisca_fr": 19, "inversion_revenu": 19, "basic_input": 19, "short": [19, 30], "basic": [19, 30], "medium": 19, "accuraci": 19, "get_package_metadata": 19, "metatada": 19, "rel": 19, "locat": 19, "dir": 19, "franc": 19, "repository_url": 19, "com": 19, "17": [19, 32], "get_parameters_at_inst": 19, "parameternodeatinst": 19, "yyyi": [19, 24], "mm": [19, 24], "dd": [19, 24], "load_extens": 19, "extens": [19, 27], "absolut": 19, "instal": [19, 25, 27], "pip": 19, "load_paramet": 19, "path_to_yaml_dir": 19, "toward": [19, 21], "neutralize_vari": [19, 31], "neutral": [19, 24, 31], "alwai": 19, "try": 19, "effect": [19, 27], "warn": 19, "replace_vari": 19, "overridden": [19, 30], "stai": 19, "unchang": 19, "taxscal": 20, "numer": 20, "tax_scale_lik": 20, "amount": [20, 30, 31], "rate_tax_scale_lik": 20, "linear": 20, "bracket_indic": 20, "tax_bas": 20, "numericalarrai": 20, "factor": 20, "round_decim": 20, "relev": [20, 30], "indic": [20, 30], "decim": 20, "round": [20, 30], "tax_scal": 20, "add_bracket": 20, "150": 20, "threshold_from_tax_bas": 20, "param": 20, "200": [20, 29], "500": [20, 32], "25": [20, 26], "450": 20, "1_150": 20, "abstract_tax_scal": 20, "abstract_rate_tax_scal": 20, "amount_tax_scale_lik": 20, "single_amount_tax_scal": 20, "calc": 20, "right": 20, "float_": 20, "cell": [20, 32], "fit": 20, "marginal_rate_tax_scal": 20, "round_base_decim": 20, "invers": 20, "invert": 20, "compos": 20, "express": [20, 30, 32], "term": 20, "gross": 20, "revenu": 20, "net": [20, 26], "gross_revenu": 20, "Then": [20, 32], "marginal_r": 20, "rate_from_bracket_indic": 20, "int64": 20, "50": [20, 26], "1_000": 20, "250": 20, "rate_from_tax_bas": 20, "scale_tax_scal": 20, "marginal_amount_tax_scal": 20, "lowest": 20, "linear_average_rate_tax_scal": 20, "miscellan": 21, "util": [21, 26], "test_runn": 21, "subdirectori": 21, "detail": 21, "below": [21, 26], "sucess": 21, "excecut": 21, "simulation_dump": 21, "later": 21, "kwarg": 21, "involv": 22, "computation_log": 22, "full_trac": 22, "print_log": 22, "max_depth": [22, 27], "print": 22, "suit": 22, "larg": [22, 28], "depth": [22, 27], "flat_trac": 22, "performance_log": 22, "simple_trac": 22, "trace_nod": 22, "children": [22, 30], "factori": 22, "end": [22, 24], "tracing_parameter_node_at_inst": 22, "well": [24, 32], "baseline_vari": 24, "altern": 24, "org": 24, "concept": 24, "html": [24, 27], "_": 24, "introduc": 24, "default_valu": 24, "defined_for": 24, "nonzero": 24, "etern": [24, 29], "35_period": 24, "multilin": 24, "text": [24, 30], "context": 24, "scipi": 24, "under": [24, 26, 32], "hood": 24, "40_legislation_evolut": 24, "disappear": 24, "_entiti": 24, "_role": 24, "exhaustive_parameter_depend": 24, "plu": 24, "haven": 24, "get_formula": 24, "oldest": 24, "get_introspection_data": 24, "instrospect": 24, "comment": 24, "hidden_input": 24, "hidden": 24, "screen": 24, "index_in_modul": 24, "is_input_vari": 24, "is_neutr": 24, "never": 24, "json_typ": 24, "max_length": 24, "limit": 24, "module_nam": 24, "parse_formula_nam": 24, "attribute_nam": 24, "formula_yyyi": 24, "formula_yyyy_mm": 24, "formula_yyyy_mm_dd": 24, "By": 24, "convent": 24, "0001": 24, "minim": 24, "enumarrai": 24, "enum": [24, 30], "quantity_typ": 24, "stock": 24, "flow": 24, "requires_computation_aft": 24, "set_input_dispatch_by_period": 24, "set_input_divide_by_period": 24, "noth": 24, "subtract": 24, "value_typ": [24, 31], "userwarn": 25, "libyaml": 25, "with_traceback": 25, "tb": 25, "__traceback__": 25, "tempfil": 25, "visualis": 26, "analys": 26, "These": 26, "style": 26, "bar_chart": 26, "export": 26, "policyengine_uk": 26, "hmrc": 26, "2023": 26, "2028": 26, "baseline_incom": 26, "household_net_incom": 26, "reformed_incom": 26, "gain": 26, "decil": 26, "household_income_decil": 26, "decile_impact": 26, "groupbi": 26, "display_fig": [26, 32], "titl": [26, 32], "xaxis_titl": [26, 32], "yaxis_titl": [26, 32], "xaxis_tickv": 26, "rang": [26, 30], "yaxis_tickformat": [26, 32], "text_format": 26, "hover_text_funct": 26, "lambda": 26, "x": [26, 30, 32], "y": [26, 30, 32], "f": 26, "cardin": 26, "show": [26, 32], "distribut": 26, "outcom": 26, "along": 26, "breakdown": [26, 30], "lower_age_group": 26, "personal_gain": 26, "cross_section_bar_chart": 26, "slice": 26, "xaxis_tickformat": [26, 32], "category_nam": 26, "lose": 26, "experi": 26, "less": [26, 30], "yaxis_ticktext": 26, "19": [26, 32], "39": 26, "40": 26, "49": 26, "59": 26, "60": 26, "69": 26, "70": 26, "79": 26, "color_discrete_map": 26, "dark_grai": 26, "medium_dark_grai": 26, "grai": 26, "light_grai": 26, "blue": [26, 32], "legend_orient": 26, "h": [26, 27], "legend_i": 26, "percent": [26, 30], "0f": [26, 32], "old": 26, "tool": 27, "manag": 27, "country_packag": 27, "name_filt": 27, "p": 27, "graph": 27, "v": 27, "o": 27, "only_vari": 27, "ignore_vari": 27, "execut": 27, "detect": 27, "attempt": 27, "scan": 27, "environ": 27, "word": 27, "partial": 27, "keyword": 27, "pdb": 27, "drop": 27, "debugg": 27, "failur": 27, "output": 27, "performance_graph": 27, "csv": 27, "verbos": 27, "increas": [27, 30], "avg": 27, "flag": 27, "maxim": 27, "ignor": 27, "upload": [27, 29], "focu": 27, "addit": 27, "won": 28, "interact": 28, "those": 28, "hold": [28, 30], "purpos": [28, 32], "country_dir": [28, 29], "ll": [28, 31, 32], "want": [28, 31, 32], "follow": [28, 30, 32], "arbitrarili": 28, "organis": 28, "usabl": 28, "situation_exampl": 28, "quickli": 28, "demonstr": 28, "py": [28, 32], "__init__": [28, 32], "main": 28, "block": 28, "abov": [28, 30], "inherit": [28, 31, 32], "here": [28, 29, 30, 31, 32], "os": 28, "coupl": 28, "coresimul": 28, "coremicrosimul": 28, "country_template_dataset": [28, 29], "countrytemplatedataset": [28, 29], "pathlib": 28, "constant": [28, 29], "few": [29, 32], "thousand": 29, "form": [29, 30], "survei": [29, 32], "techniqu": 29, "impact": 29, "compar": 29, "we": [29, 32], "templat": 29, "folder_path": 29, "raw": 29, "household_id": 29, "person_household_id": 29, "person_household_rol": 29, "salary_time_period": 29, "1e6": [29, 32], "2e6": 29, "weight_time_period": 29, "household_weight": 29, "save_variable_valu": 29, "dynam": 29, "publicdataset": 29, "publicli": 29, "privatedataset": 29, "privat": 29, "googl": 29, "cloud": 29, "bucket": 29, "subnod": 30, "child_benefit": [30, 31], "national_insur": 30, "employe": 30, "universal_credit": 30, "achiev": 30, "histori": 30, "2019": [30, 31, 32], "00": 30, "21": 30, "03": 30, "22": 30, "23": 30, "while": 30, "freeform": 30, "schema": 30, "data_structur": 30, "ensur": [30, 31], "consist": 30, "better": 30, "paid": 30, "currenc": 30, "gbp": 30, "href": [30, 32], "www": 30, "govern": 30, "public": 30, "parametermetadata": 30, "longer": 30, "mean": 30, "displai": 30, "sentenc": 30, "snake": 30, "safe": 30, "real": 30, "world": 30, "upratingindex": 30, "upratingschema": 30, "look": 30, "forward": 30, "z": 30, "parameternodemetadata": 30, "variablebreakdown": 30, "dynamicbreakdown": 30, "grandchildren": 30, "further": 30, "descend": 30, "region": 30, "england": 30, "wale": 30, "eval": 30, "uat": 30, "produc": 30, "great": 30, "unless": 30, "propagate_metadata_to_children": 30, "propag": 30, "exclud": 30, "piec": 30, "link": 30, "eur": 30, "euro": 30, "british": 30, "pound": 30, "sterl": 30, "percentag": 30, "usd": 30, "dollar": 30, "parameter_metadata": 30, "selfupr": 30, "special": 30, "upratingroundingconfig": 30, "nearest": 30, "upward": 30, "downward": 30, "configur": 30, "parameter_node_metadata": 30, "wai": 31, "new_variable_class": 31, "overriding_variable_class": 31, "everyth": [31, 32], "new_vari": 31, "argument": 31, "throw": 31, "alreadi": 31, "overrid": 31, "zero": 31, "essenti": 31, "law": 32, "repositori": 32, "page": 32, "simpl": 32, "meet": 32, "30_000": 32, "4500": 32, "float32": 32, "three": 32, "often": 32, "perpendicular": 32, "parallel": 32, "vari": 32, "100_000": 32, "1666": 32, "6667": 32, "3333": 32, "3335": 32, "5000": 32, "6666": 32, "667": 32, "8333": 32, "334": 32, "10000": 32, "11666": 32, "668": 32, "13333": 32, "15000": 32, "001": 32, "plotli": 32, "px": 32, "chart": 32, "format_fig": 32, "fig": 32, "color_discrete_sequ": 32, "update_layout": 32, "xaxis_tickprefix": 32, "yaxis_tickprefix": 32, "update_trac": 32, "hovertempl": 32, "b": 32, "br": 32, "importerror": 32, "recent": 32, "nikhil": 32, "ipynb": 32, "vscode": 32, "notebook": 32, "x11szmlszq": 32, "3d": 32, "16": 32, "18": 32, "As": 32, "weightedsimul": 32, "former": 32, "latter": 32, "sim": 32, "51": 32, "000003242492674": 32, "inspect": 32, "actual": 32, "microdf": 32, "panda": 32, "seri": 32, "extra": 32, "intuit": 32, "treat": 32, "were": 32}, "objects": {"policyengine_core.commons.formulas": [[2, 0, 1, "", "apply_thresholds"], [2, 0, 1, "", "concat"], [2, 0, 1, "", "switch"]], "policyengine_core.country_template": [[3, 1, 1, "", "CountryTaxBenefitSystem"]], "policyengine_core.country_template.CountryTaxBenefitSystem": [[3, 2, 1, "", "auto_carry_over_input_variables"], [3, 2, 1, "", "entities"], [3, 2, 1, "", "modelled_policies"], [3, 2, 1, "", "parameters_dir"], [3, 2, 1, "", "variables_dir"]], "policyengine_core.data": [[4, 1, 1, "", "Dataset"]], "policyengine_core.data.Dataset": [[4, 2, 1, "", "ARRAYS"], [4, 2, 1, "", "TABLES"], [4, 2, 1, "", "TIME_PERIOD_ARRAYS"], [4, 2, 1, "", "data_format"], [4, 3, 1, "", "download"], [4, 4, 1, "", "exists"], [4, 2, 1, "", "file_path"], [4, 3, 1, "", "generate"], [4, 2, 1, "", "label"], [4, 3, 1, "", "load"], [4, 3, 1, "", "load_dataset"], [4, 2, 1, "", "name"], [4, 3, 1, "", "remove"], [4, 3, 1, "", "save"], [4, 3, 1, "", "save_dataset"], [4, 3, 1, "", "store_file"], [4, 2, 1, "", "time_period"], [4, 2, 1, "", "url"], [4, 4, 1, "", "variables"]], "policyengine_core.data_storage.in_memory_storage": [[5, 1, 1, "", "InMemoryStorage"]], "policyengine_core.data_storage.in_memory_storage.InMemoryStorage": [[5, 3, 1, "", "clone"], [5, 3, 1, "", "delete"], [5, 3, 1, "", "get"], [5, 3, 1, "", "get_known_branch_periods"], [5, 3, 1, "", "get_known_periods"], [5, 3, 1, "", "get_memory_usage"], [5, 2, 1, "", "is_eternal"], [5, 3, 1, "", "put"]], "policyengine_core.data_storage.on_disk_storage": [[5, 1, 1, "", "OnDiskStorage"]], "policyengine_core.data_storage.on_disk_storage.OnDiskStorage": [[5, 3, 1, "", "delete"], [5, 3, 1, "", "get"], [5, 3, 1, "", "get_known_branch_periods"], [5, 3, 1, "", "get_known_periods"], [5, 3, 1, "", "put"], [5, 3, 1, "", "restore"]], "policyengine_core.data_structures": [[30, 1, 1, "", "ParameterMetadata"], [30, 1, 1, "", "ParameterNodeMetadata"], [30, 1, 1, "", "Reference"], [30, 1, 1, "", "Unit"], [30, 5, 0, "-", "parameter_metadata"], [30, 5, 0, "-", "parameter_node_metadata"]], "policyengine_core.data_structures.ParameterMetadata": [[30, 2, 1, "", "description"], [30, 2, 1, "", "documentation"], [30, 2, 1, "", "label"], [30, 2, 1, "", "name"], [30, 2, 1, "", "reference"], [30, 2, 1, "", "unit"], [30, 2, 1, "", "uprating"]], "policyengine_core.data_structures.ParameterNodeMetadata": [[30, 2, 1, "", "breakdown"], [30, 2, 1, "", "label"], [30, 2, 1, "", "name"], [30, 2, 1, "", "propagate_metadata_to_children"], [30, 2, 1, "", "reference"]], "policyengine_core.data_structures.Reference": [[30, 2, 1, "", "href"], [30, 2, 1, "", "label"], [30, 2, 1, "", "type"]], "policyengine_core.data_structures.Unit": [[30, 2, 1, "", "EUR"], [30, 2, 1, "", "GBP"], [30, 2, 1, "", "PERCENT"], [30, 2, 1, "", "USD"]], "policyengine_core.data_structures.parameter_metadata": [[30, 1, 1, "", "SelfUprating"], [30, 1, 1, "", "UpratingIndex"], [30, 1, 1, "", "UpratingRoundingConfig"], [30, 1, 1, "", "UpratingSchema"]], "policyengine_core.data_structures.parameter_metadata.UpratingRoundingConfig": [[30, 2, 1, "", "interval"], [30, 2, 1, "", "type"]], "policyengine_core.data_structures.parameter_metadata.UpratingSchema": [[30, 2, 1, "", "parameter"], [30, 2, 1, "", "start_instant"], [30, 2, 1, "", "type"]], "policyengine_core.data_structures.parameter_node_metadata": [[30, 1, 1, "", "DynamicBreakdown"], [30, 1, 1, "", "VariableBreakdown"]], "policyengine_core.entities.entity": [[6, 1, 1, "", "Entity"]], "policyengine_core.entities.entity.Entity": [[6, 3, 1, "", "check_role_validity"], [6, 3, 1, "", "check_variable_defined_for_entity"], [6, 3, 1, "", "get_variable"], [6, 3, 1, "", "set_tax_benefit_system"]], "policyengine_core.entities.group_entity": [[6, 1, 1, "", "GroupEntity"]], "policyengine_core.entities.helpers": [[6, 0, 1, "", "build_entity"]], "policyengine_core.entities.role": [[6, 1, 1, "", "Role"]], "policyengine_core.enums.enum": [[7, 1, 1, "", "Enum"]], "policyengine_core.enums.enum.Enum": [[7, 3, 1, "", "encode"]], "policyengine_core.enums.enum_array": [[7, 1, 1, "", "EnumArray"]], "policyengine_core.enums.enum_array.EnumArray": [[7, 3, 1, "", "decode"], [7, 3, 1, "", "decode_to_str"]], "policyengine_core.errors.nan_creation_error": [[8, 1, 1, "", "NaNCreationError"]], "policyengine_core.errors.parameter_not_found_error": [[8, 1, 1, "", "ParameterNotFoundError"]], "policyengine_core.errors.parameter_parsing_error": [[8, 1, 1, "", "ParameterParsingError"]], "policyengine_core.errors.period_mismatch_error": [[8, 1, 1, "", "PeriodMismatchError"]], "policyengine_core.errors.situation_parsing_error": [[8, 1, 1, "", "SituationParsingError"]], "policyengine_core.errors.spiral_error": [[8, 1, 1, "", "SpiralError"]], "policyengine_core.errors.variable_name_conflict_error": [[8, 1, 1, "", "VariableNameConflictError"]], "policyengine_core.errors.variable_not_found_error": [[8, 1, 1, "", "VariableNotFoundError"]], "policyengine_core.experimental.memory_config": [[9, 1, 1, "", "MemoryConfig"]], "policyengine_core.holders.helpers": [[11, 0, 1, "", "set_input_dispatch_by_period"], [11, 0, 1, "", "set_input_divide_by_period"]], "policyengine_core.holders.holder": [[11, 1, 1, "", "Holder"]], "policyengine_core.holders.holder.Holder": [[11, 3, 1, "", "clone"], [11, 3, 1, "", "create_disk_storage"], [11, 3, 1, "", "default_array"], [11, 3, 1, "", "delete_arrays"], [11, 3, 1, "", "get_array"], [11, 3, 1, "", "get_known_branch_periods"], [11, 3, 1, "", "get_known_periods"], [11, 3, 1, "", "get_memory_usage"], [11, 3, 1, "", "put_in_cache"], [11, 3, 1, "", "set_input"]], "policyengine_core.parameters.at_instant_like": [[12, 1, 1, "", "AtInstantLike"]], "policyengine_core.parameters.at_instant_like.AtInstantLike": [[12, 3, 1, "", "get_at_instant"]], "policyengine_core.parameters.helpers": [[12, 0, 1, "", "contains_nan"], [12, 0, 1, "", "load_parameter_file"]], "policyengine_core.parameters.parameter": [[12, 1, 1, "", "Parameter"]], "policyengine_core.parameters.parameter.Parameter": [[12, 3, 1, "", "clone"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "mark_as_modified"], [12, 3, 1, "", "update"], [12, 2, 1, "", "values_list"]], "policyengine_core.parameters.parameter_at_instant": [[12, 1, 1, "", "ParameterAtInstant"]], "policyengine_core.parameters.parameter_at_instant.ParameterAtInstant": [[12, 3, 1, "", "clone"], [12, 3, 1, "", "validate"]], "policyengine_core.parameters.parameter_node": [[12, 1, 1, "", "ParameterNode"]], "policyengine_core.parameters.parameter_node.ParameterNode": [[12, 3, 1, "", "add_child"], [12, 3, 1, "", "attach_to_parent"], [12, 3, 1, "", "clear_parent_cache"], [12, 3, 1, "", "clone"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "mark_as_modified"], [12, 3, 1, "", "merge"], [12, 2, 1, "", "parent"]], "policyengine_core.parameters.parameter_node_at_instant": [[12, 1, 1, "", "ParameterNodeAtInstant"]], "policyengine_core.parameters.parameter_node_at_instant.ParameterNodeAtInstant": [[12, 3, 1, "", "add_child"]], "policyengine_core.parameters.parameter_scale": [[12, 1, 1, "", "ParameterScale"]], "policyengine_core.parameters.parameter_scale.ParameterScale": [[12, 3, 1, "", "clone"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "propagate_units"], [12, 3, 1, "", "propagate_uprating"]], "policyengine_core.parameters.parameter_scale_bracket": [[12, 1, 1, "", "ParameterScaleBracket"]], "policyengine_core.parameters.parameter_scale_bracket.ParameterScaleBracket": [[12, 3, 1, "", "allowed_unit_keys"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "propagate_uprating"]], "policyengine_core.parameters.vectorial_parameter_node_at_instant": [[12, 1, 1, "", "VectorialParameterNodeAtInstant"]], "policyengine_core.parameters.vectorial_parameter_node_at_instant.VectorialParameterNodeAtInstant": [[12, 3, 1, "", "build_from_node"], [12, 3, 1, "", "check_node_vectorisable"]], "policyengine_core.periods.helpers": [[13, 0, 1, "", "instant"], [13, 0, 1, "", "period"]], "policyengine_core.periods.instant_": [[13, 1, 1, "", "Instant"]], "policyengine_core.periods.instant_.Instant": [[13, 4, 1, "", "date"], [13, 4, 1, "", "day"], [13, 4, 1, "", "month"], [13, 3, 1, "", "offset"], [13, 3, 1, "", "period"], [13, 4, 1, "", "year"]], "policyengine_core.periods.period_": [[13, 1, 1, "", "Period"]], "policyengine_core.periods.period_.Period": [[13, 3, 1, "", "contains"], [13, 4, 1, "", "date"], [13, 4, 1, "", "days"], [13, 4, 1, "", "first_day"], [13, 4, 1, "", "first_month"], [13, 3, 1, "", "get_subperiods"], [13, 3, 1, "", "intersection"], [13, 4, 1, "", "last_3_months"], [13, 4, 1, "", "last_month"], [13, 4, 1, "", "last_year"], [13, 4, 1, "", "n_2"], [13, 3, 1, "", "offset"], [13, 4, 1, "", "size"], [13, 4, 1, "", "size_in_days"], [13, 4, 1, "", "size_in_months"], [13, 4, 1, "", "start"], [13, 4, 1, "", "stop"], [13, 4, 1, "", "this_year"], [13, 4, 1, "", "unit"]], "policyengine_core.populations.group_population": [[14, 1, 1, "", "GroupPopulation"]], "policyengine_core.populations.group_population.GroupPopulation": [[14, 3, 1, "", "all"], [14, 3, 1, "", "any"], [14, 3, 1, "", "clone"], [14, 3, 1, "", "get_role"], [14, 3, 1, "", "max"], [14, 4, 1, "", "members_entity_id"], [14, 4, 1, "", "members_position"], [14, 4, 1, "", "members_role"], [14, 3, 1, "", "min"], [14, 3, 1, "", "nb_persons"], [14, 4, 1, "", "ordered_members_map"], [14, 3, 1, "", "project"], [14, 3, 1, "", "reduce"], [14, 3, 1, "", "sum"], [14, 3, 1, "", "value_from_first_person"], [14, 3, 1, "", "value_from_person"], [14, 3, 1, "", "value_nth_person"]], "policyengine_core.populations.population": [[14, 1, 1, "", "Population"]], "policyengine_core.populations.population.Population": [[14, 3, 1, "", "check_array_compatible_with_entity"], [14, 3, 1, "", "check_period_validity"], [14, 3, 1, "", "clone"], [14, 3, 1, "", "empty_array"], [14, 3, 1, "", "filled_array"], [14, 3, 1, "", "get_holder"], [14, 3, 1, "", "get_index"], [14, 3, 1, "", "get_memory_usage"], [14, 3, 1, "", "get_rank"], [14, 3, 1, "", "has_role"], [14, 3, 1, "", "value_from_partner"]], "policyengine_core.projectors": [[15, 1, 1, "", "EntityToPersonProjector"], [15, 1, 1, "", "FirstPersonToEntityProjector"], [15, 1, 1, "", "Projector"], [15, 1, 1, "", "UniqueRoleToEntityProjector"]], "policyengine_core.reforms": [[16, 1, 1, "", "Reform"]], "policyengine_core.reforms.Reform": [[16, 2, 1, "", "country_id"], [16, 3, 1, "", "from_api"], [16, 3, 1, "", "from_dict"], [16, 3, 1, "", "modify_parameters"], [16, 2, 1, "", "name"], [16, 2, 1, "", "parameter_values"]], "policyengine_core.simulations.microsimulation": [[18, 1, 1, "", "Microsimulation"]], "policyengine_core.simulations.microsimulation.Microsimulation": [[18, 3, 1, "", "apply_reform"], [18, 2, 1, "", "baseline"], [18, 2, 1, "", "branches"], [18, 3, 1, "", "build_from_dataset"], [18, 3, 1, "", "build_from_populations"], [18, 3, 1, "", "calculate"], [18, 3, 1, "", "calculate_add"], [18, 3, 1, "", "calculate_dataframe"], [18, 3, 1, "", "calculate_divide"], [18, 3, 1, "", "calculate_output"], [18, 3, 1, "", "clear_macro_cache"], [18, 3, 1, "", "clone"], [18, 3, 1, "", "create_shortcuts"], [18, 4, 1, "", "data_storage_dir"], [18, 2, 1, "", "dataset"], [18, 2, 1, "", "datasets"], [18, 2, 1, "", "debug"], [18, 2, 1, "", "default_calculation_period"], [18, 2, 1, "", "default_dataset"], [18, 2, 1, "", "default_input_period"], [18, 2, 1, "", "default_role"], [18, 2, 1, "", "default_tax_benefit_system"], [18, 2, 1, "", "default_tax_benefit_system_instance"], [18, 3, 1, "", "delete_arrays"], [18, 3, 1, "", "derivative"], [18, 3, 1, "", "describe_entities"], [18, 3, 1, "", "extract_person"], [18, 3, 1, "", "get_array"], [18, 3, 1, "", "get_branch"], [18, 3, 1, "", "get_entity"], [18, 3, 1, "", "get_holder"], [18, 3, 1, "", "get_known_periods"], [18, 3, 1, "", "get_memory_usage"], [18, 3, 1, "", "get_population"], [18, 3, 1, "", "get_variable_population"], [18, 3, 1, "", "get_weights"], [18, 3, 1, "", "invalidate_cache_entry"], [18, 3, 1, "", "invalidate_spiral_variables"], [18, 2, 1, "", "is_over_dataset"], [18, 3, 1, "", "link_to_entities_instances"], [18, 2, 1, "", "macro_cache_read"], [18, 2, 1, "", "macro_cache_write"], [18, 3, 1, "", "map_result"], [18, 2, 1, "", "max_spiral_loops"], [18, 2, 1, "", "memory_config"], [18, 2, 1, "", "opt_out_cache"], [18, 3, 1, "", "purge_cache_of_invalid_values"], [18, 3, 1, "", "sample_person"], [18, 3, 1, "", "set_input"], [18, 4, 1, "", "trace"], [18, 2, 1, "", "tracer"]], "policyengine_core.simulations.simulation": [[18, 1, 1, "", "Simulation"]], "policyengine_core.simulations.simulation.Simulation": [[18, 3, 1, "", "apply_reform"], [18, 2, 1, "", "baseline"], [18, 3, 1, "", "build_from_dataset"], [18, 3, 1, "", "build_from_populations"], [18, 3, 1, "", "calculate"], [18, 3, 1, "", "calculate_add"], [18, 3, 1, "", "calculate_dataframe"], [18, 3, 1, "", "calculate_divide"], [18, 3, 1, "", "calculate_output"], [18, 3, 1, "", "clear_macro_cache"], [18, 3, 1, "", "clone"], [18, 3, 1, "", "create_shortcuts"], [18, 4, 1, "", "data_storage_dir"], [18, 2, 1, "", "datasets"], [18, 2, 1, "", "default_calculation_period"], [18, 2, 1, "", "default_dataset"], [18, 2, 1, "", "default_input_period"], [18, 2, 1, "", "default_role"], [18, 2, 1, "", "default_tax_benefit_system"], [18, 2, 1, "", "default_tax_benefit_system_instance"], [18, 3, 1, "", "delete_arrays"], [18, 3, 1, "", "derivative"], [18, 3, 1, "", "describe_entities"], [18, 3, 1, "", "extract_person"], [18, 3, 1, "", "get_array"], [18, 3, 1, "", "get_branch"], [18, 3, 1, "", "get_entity"], [18, 3, 1, "", "get_holder"], [18, 3, 1, "", "get_known_periods"], [18, 3, 1, "", "get_memory_usage"], [18, 3, 1, "", "get_population"], [18, 3, 1, "", "get_variable_population"], [18, 3, 1, "", "invalidate_cache_entry"], [18, 3, 1, "", "invalidate_spiral_variables"], [18, 2, 1, "", "is_over_dataset"], [18, 3, 1, "", "link_to_entities_instances"], [18, 2, 1, "", "macro_cache_read"], [18, 2, 1, "", "macro_cache_write"], [18, 3, 1, "", "map_result"], [18, 3, 1, "", "purge_cache_of_invalid_values"], [18, 3, 1, "", "sample_person"], [18, 3, 1, "", "set_input"], [18, 4, 1, "", "trace"]], "policyengine_core.simulations.simulation_builder": [[18, 1, 1, "", "SimulationBuilder"]], "policyengine_core.simulations.simulation_builder.SimulationBuilder": [[18, 3, 1, "", "add_default_group_entity"], [18, 3, 1, "", "add_group_entity"], [18, 3, 1, "", "add_parallel_axis"], [18, 3, 1, "", "add_perpendicular_axis"], [18, 3, 1, "", "add_person_entity"], [18, 3, 1, "", "add_variable_value"], [18, 3, 1, "", "build"], [18, 3, 1, "", "build_default_simulation"], [18, 3, 1, "", "build_from_dict"], [18, 3, 1, "", "build_from_entities"], [18, 3, 1, "", "build_from_variables"], [18, 3, 1, "", "check_persons_to_allocate"], [18, 3, 1, "", "create_entities"], [18, 3, 1, "", "declare_entity"], [18, 3, 1, "", "declare_person_entity"], [18, 3, 1, "", "expand_axes"], [18, 3, 1, "", "explicit_singular_entities"], [18, 3, 1, "", "finalize_variables_init"], [18, 3, 1, "", "get_count"], [18, 3, 1, "", "get_ids"], [18, 3, 1, "", "get_input"], [18, 3, 1, "", "get_memberships"], [18, 3, 1, "", "get_roles"], [18, 3, 1, "", "get_variable_entity"], [18, 3, 1, "", "init_variable_values"], [18, 3, 1, "", "join_with_persons"], [18, 3, 1, "", "nb_persons"], [18, 3, 1, "", "raise_period_mismatch"], [18, 3, 1, "", "register_variable"], [18, 3, 1, "", "set_default_period"]], "policyengine_core.taxbenefitsystems.tax_benefit_system": [[19, 1, 1, "", "TaxBenefitSystem"]], "policyengine_core.taxbenefitsystems.tax_benefit_system.TaxBenefitSystem": [[19, 3, 1, "", "add_modelled_policy_metadata"], [19, 3, 1, "", "add_variable"], [19, 3, 1, "", "add_variable_metadata_from_folder"], [19, 3, 1, "", "add_variables"], [19, 3, 1, "", "add_variables_from_directory"], [19, 3, 1, "", "add_variables_from_file"], [19, 3, 1, "", "apply_reform"], [19, 2, 1, "", "auto_carry_over_input_variables"], [19, 2, 1, "", "basic_inputs"], [19, 2, 1, "", "entities"], [19, 3, 1, "", "get_package_metadata"], [19, 3, 1, "", "get_parameters_at_instant"], [19, 3, 1, "", "get_variable"], [19, 3, 1, "", "get_variables"], [19, 3, 1, "", "load_extension"], [19, 3, 1, "", "load_parameters"], [19, 2, 1, "", "modelled_policies"], [19, 3, 1, "", "modify_parameters"], [19, 3, 1, "", "neutralize_variable"], [19, 2, 1, "", "parameters"], [19, 2, 1, "", "parameters_dir"], [19, 3, 1, "", "replace_variable"], [19, 3, 1, "", "update_variable"], [19, 2, 1, "", "variables_dir"]], "policyengine_core.taxscales.abstract_rate_tax_scale": [[20, 1, 1, "", "AbstractRateTaxScale"]], "policyengine_core.taxscales.abstract_rate_tax_scale.AbstractRateTaxScale": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.abstract_tax_scale": [[20, 1, 1, "", "AbstractTaxScale"]], "policyengine_core.taxscales.amount_tax_scale_like": [[20, 1, 1, "", "AmountTaxScaleLike"]], "policyengine_core.taxscales.linear_average_rate_tax_scale": [[20, 1, 1, "", "LinearAverageRateTaxScale"]], "policyengine_core.taxscales.linear_average_rate_tax_scale.LinearAverageRateTaxScale": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.marginal_amount_tax_scale": [[20, 1, 1, "", "MarginalAmountTaxScale"]], "policyengine_core.taxscales.marginal_amount_tax_scale.MarginalAmountTaxScale": [[20, 3, 1, "", "calc"]], "policyengine_core.taxscales.marginal_rate_tax_scale": [[20, 1, 1, "", "MarginalRateTaxScale"]], "policyengine_core.taxscales.marginal_rate_tax_scale.MarginalRateTaxScale": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "calc"], [20, 3, 1, "", "inverse"], [20, 3, 1, "", "marginal_rates"], [20, 3, 1, "", "rate_from_bracket_indice"], [20, 3, 1, "", "rate_from_tax_base"], [20, 3, 1, "", "scale_tax_scales"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.rate_tax_scale_like": [[20, 1, 1, "", "RateTaxScaleLike"]], "policyengine_core.taxscales.rate_tax_scale_like.RateTaxScaleLike": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.single_amount_tax_scale": [[20, 1, 1, "", "SingleAmountTaxScale"]], "policyengine_core.taxscales.single_amount_tax_scale.SingleAmountTaxScale": [[20, 3, 1, "", "calc"]], "policyengine_core.taxscales.tax_scale_like": [[20, 1, 1, "", "TaxScaleLike"]], "policyengine_core.tools.simulation_dumper": [[21, 0, 1, "", "dump_simulation"], [21, 0, 1, "", "restore_simulation"]], "policyengine_core.tools.test_runner": [[21, 0, 1, "", "run_tests"]], "policyengine_core.tracers.computation_log": [[22, 1, 1, "", "ComputationLog"]], "policyengine_core.tracers.computation_log.ComputationLog": [[22, 3, 1, "", "print_log"]], "policyengine_core.tracers.flat_trace": [[22, 1, 1, "", "FlatTrace"]], "policyengine_core.tracers.full_tracer": [[22, 1, 1, "", "FullTracer"]], "policyengine_core.tracers.performance_log": [[22, 1, 1, "", "PerformanceLog"]], "policyengine_core.tracers.simple_tracer": [[22, 1, 1, "", "SimpleTracer"]], "policyengine_core.tracers.trace_node": [[22, 1, 1, "", "TraceNode"]], "policyengine_core.tracers.tracing_parameter_node_at_instant": [[22, 1, 1, "", "TracingParameterNodeAtInstant"]], "policyengine_core.variables.variable": [[24, 1, 1, "", "Variable"]], "policyengine_core.variables.variable.Variable": [[24, 2, 1, "", "adds"], [24, 2, 1, "", "baseline_variable"], [24, 2, 1, "", "default_value"], [24, 2, 1, "", "defined_for"], [24, 2, 1, "", "definition_period"], [24, 2, 1, "", "documentation"], [24, 2, 1, "", "dtype"], [24, 2, 1, "", "end"], [24, 2, 1, "", "entity"], [24, 2, 1, "", "exhaustive_parameter_dependencies"], [24, 2, 1, "", "formulas"], [24, 3, 1, "", "get_formula"], [24, 3, 1, "", "get_introspection_data"], [24, 2, 1, "", "hidden_input"], [24, 2, 1, "", "index_in_module"], [24, 3, 1, "", "is_input_variable"], [24, 2, 1, "", "is_neutralized"], [24, 2, 1, "", "json_type"], [24, 2, 1, "", "label"], [24, 2, 1, "", "max_length"], [24, 2, 1, "", "metadata"], [24, 2, 1, "", "module_name"], [24, 2, 1, "", "name"], [24, 3, 1, "", "parse_formula_name"], [24, 2, 1, "", "possible_values"], [24, 2, 1, "", "quantity_type"], [24, 2, 1, "", "reference"], [24, 2, 1, "", "requires_computation_after"], [24, 2, 1, "", "set_input"], [24, 2, 1, "", "subtracts"], [24, 2, 1, "", "unit"], [24, 2, 1, "", "uprating"], [24, 2, 1, "", "value_type"]], "policyengine_core.warnings": [[25, 1, 1, "", "LibYAMLWarning"], [25, 1, 1, "", "MemoryConfigWarning"], [25, 1, 1, "", "TempfileWarning"]], "policyengine_core.warnings.LibYAMLWarning": [[25, 3, 1, "", "with_traceback"]], "policyengine_core.warnings.MemoryConfigWarning": [[25, 3, 1, "", "with_traceback"]], "policyengine_core.warnings.TempfileWarning": [[25, 3, 1, "", "with_traceback"]]}, "objtypes": {"0": "py:function", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:module"}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "module", "Python module"]}, "titleterms": {"how": 0, "contribut": 0, "changelog": 0, "entri": 0, "pull": 0, "request": 0, "introduct": 1, "common": 2, "formula": 2, "apply_threshold": 2, "concat": 2, "switch": 2, "countri": [3, 28], "templat": [3, 10], "countrytaxbenefitsystem": 3, "data": [4, 5, 27], "dataset": [4, 29], "publicdataset": 4, "privatedataset": 4, "storag": 5, "inmemorystorag": 5, "ondiskstorag": 5, "entiti": 6, "groupent": 6, "role": 6, "build_ent": 6, "enum": 7, "enumarrai": 7, "error": 8, "nancreationerror": 8, "parameternotfounderror": 8, "parameterparsingerror": 8, "periodmismatcherror": 8, "situationparsingerror": 8, "spiralerror": 8, "variablenameconflicterror": 8, "variablenotfounderror": 8, "experiment": 9, "featur": 9, "memoryconfig": 9, "extens": 10, "holder": 11, "set_input_dispatch_by_period": 11, "set_input_divide_by_period": 11, "paramet": [12, 30, 31], "parameternod": 12, "parameteratinst": 12, "parameternodeatinst": 12, "parameterscal": 12, "parameterscalebracket": 12, "atinstantlik": 12, "vectorialparameternodeatinst": 12, "contains_nan": 12, "load_parameter_fil": 12, "period": 13, "instant": 13, "popul": [14, 32], "grouppopul": 14, "projector": 15, "entitytopersonprojector": 15, "firstpersontoentityprojector": 15, "uniqueroletoentityprojector": 15, "reform": [16, 31], "script": 17, "simul": [18, 32], "microsimul": 18, "simulationbuild": 18, "tax": [19, 20], "benefit": 19, "system": 19, "taxbenefitsystem": 19, "scale": 20, "taxscalelik": 20, "ratetaxscalelik": 20, "abstracttaxscal": 20, "abstractratetaxscal": 20, "amounttaxscalelik": 20, "singleamounttaxscal": 20, "marginalratetaxscal": 20, "marginalamounttaxscal": 20, "linearaverageratetaxscal": 20, "tool": 21, "run_test": 21, "dump_simul": 21, "restore_simul": 21, "tracer": 22, "computationlog": 22, "flattrac": 22, "fulltrac": 22, "performancelog": 22, "simpletrac": 22, "tracenod": 22, "tracingparameternodeatinst": 22, "type": 23, "variabl": [24, 31], "warn": 25, "libyamlwarn": 25, "memoryconfigwarn": 25, "tempfilewarn": 25, "chart": 26, "bar": 26, "cross": 26, "section": 26, "us": 27, "command": 27, "line": 27, "interfac": [27, 28], "posit": 27, "argument": 27, "sub": 27, "test": 27, "name": 27, "creat": 28, "packag": 28, "build": 28, "repo": 28, "write": [29, 30, 31], "exampl": 29, "api": 29, "valu": 30, "metadata": 30, "node": 30, "specifi": 30, "refer": 30, "unit": 30, "other": 30, "specif": 30, "modifi": 31, "polici": 32, "individu": 32, "household": 32, "over": 32, "ax": 32}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["contributing/intro", "intro", "python_api/commons", "python_api/country_template", "python_api/data", "python_api/data_storage", "python_api/entities", "python_api/enums", "python_api/errors", "python_api/experimental", "python_api/extension_template", "python_api/holders", "python_api/parameters", "python_api/periods", "python_api/populations", "python_api/projectors", "python_api/reforms", "python_api/scripts", "python_api/simulations", "python_api/taxbenefitsystems", "python_api/taxscales", "python_api/tools", "python_api/tracers", "python_api/types", "python_api/variables", "python_api/warnings", "usage/charts", "usage/cli", "usage/country", "usage/datasets", "usage/parameters", "usage/reforms", "usage/simulation"], "filenames": ["contributing/intro.md", "intro.md", "python_api/commons.md", "python_api/country_template.md", "python_api/data.md", "python_api/data_storage.md", "python_api/entities.md", "python_api/enums.md", "python_api/errors.md", "python_api/experimental.md", "python_api/extension_template.md", "python_api/holders.md", "python_api/parameters.md", "python_api/periods.md", "python_api/populations.md", "python_api/projectors.md", "python_api/reforms.md", "python_api/scripts.md", "python_api/simulations.md", "python_api/taxbenefitsystems.md", "python_api/taxscales.md", "python_api/tools.md", "python_api/tracers.md", "python_api/types.md", "python_api/variables.md", "python_api/warnings.md", "usage/charts.ipynb", "usage/cli.md", "usage/country.ipynb", "usage/datasets.ipynb", "usage/parameters.md", "usage/reforms.md", "usage/simulation.ipynb"], "titles": ["How to contribute", "Introduction", "Commons", "Country template", "Data", "Data storage", "Entities", "Enums", "Errors", "Experimental features", "Extension template", "Holders", "Parameters", "Periods", "Populations", "Projectors", "Reforms", "Scripts", "Simulations", "Tax-benefit systems", "Tax scales", "Tools", "Tracers", "Types", "Variables", "Warnings", "Charts", "Using the command-line interface", "Creating a country package", "Writing datasets", "Writing parameters", "Writing reforms", "Simulating policy"], "terms": {"ani": [0, 1, 2, 5, 6, 10, 11, 12, 14, 16, 18, 20, 24, 27, 30, 32], "all": [0, 4, 11, 12, 13, 14, 16, 18, 19, 20, 21, 27, 28, 30, 31], "ar": [0, 1, 2, 5, 6, 7, 8, 11, 12, 14, 18, 19, 20, 22, 24, 28, 30, 31], "welcom": 0, "thi": [0, 1, 2, 4, 6, 11, 12, 14, 16, 18, 19, 22, 24, 27, 28, 29, 30, 31, 32], "project": [0, 14], "you": [0, 4, 18, 28, 31, 32], "can": [0, 1, 4, 6, 7, 11, 12, 13, 16, 18, 19, 21, 24, 28, 29, 30, 31, 32], "help": 0, "file": [0, 3, 4, 8, 12, 19, 21, 24, 27, 28, 30], "issu": 0, "tell": 0, "us": [0, 1, 2, 3, 4, 5, 7, 10, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32], "about": [0, 11, 15, 18, 24, 30], "bug": 0, "ve": 0, "found": [0, 8, 19], "featur": [0, 4], "d": [0, 27], "like": [0, 4], "see": [0, 14, 19, 21, 24, 26, 29, 32], "fix": [0, 30], "an": [0, 2, 4, 6, 7, 8, 10, 11, 12, 13, 14, 16, 18, 19, 24, 27, 28, 30, 31, 32], "someon": 0, "els": 0, "ha": [0, 4, 8, 11, 12, 14, 18, 19, 24, 27, 28], "If": [0, 4, 11, 12, 14, 18, 19, 20, 21, 22, 24, 27, 30, 31, 32], "one": [0, 2, 4, 8, 18, 19, 20, 32], "maintain": [0, 1, 30], "primarili": 0, "nikhilwoodruff": 0, "respond": 0, "within": [0, 2, 14, 20], "least": 0, "week": 0, "don": [0, 10, 14, 32], "t": [0, 2, 8, 9, 10, 14, 18, 24, 28, 30, 32], "hear": 0, "back": 0, "feel": 0, "free": [0, 7, 24], "ping": 0, "befor": [0, 24, 30], "send": 0, "out": 0, "make": [0, 2, 16, 19], "sure": [0, 32], "add": [0, 12, 16, 18, 19, 24, 29, 30, 31], "descript": [0, 6, 12, 18, 24, 30, 32], "your": [0, 3, 10, 27], "chang": [0, 6, 12, 18, 24, 26, 30, 31, 32], "changelog_entri": 0, "yaml": [0, 3, 12, 16, 19, 21, 27, 30], "For": [0, 7, 13, 15, 20, 24, 30, 31, 32], "exampl": [0, 2, 7, 11, 13, 14, 15, 16, 18, 19, 22, 26, 28, 30, 31, 32], "bump": 0, "patch": 0, "caus": 0, "window": 0, "test": [0, 17, 21, 28, 29], "fail": 0, "find": [0, 32], "more": [0, 11, 18, 21, 22, 24, 26], "note": [0, 14], "do": [0, 27, 29, 31, 32], "need": [0, 4, 27, 28, 29, 31, 32], "date": [0, 13, 24, 30], "field": [0, 24, 30], "That": 0, "automat": [0, 3, 4, 19, 24, 27], "popul": [0, 11, 15, 18, 22, 28, 29], "also": [0, 1, 19, 28, 29, 30, 31, 32], "should": [0, 4, 12, 16, 18, 19, 28, 30, 31, 32], "run": [0, 6, 11, 18, 21, 27], "yourself": 0, "our": [0, 11, 32], "github": [0, 19], "workflow": 0, "part": [0, 29], "build": [0, 1, 18], "process": [0, 1, 24, 30], "each": [0, 1, 2, 11, 18, 22, 24, 28, 30, 32], "close": 0, "isn": 0, "complet": [0, 4], "address": 0, "pleas": 0, "have": [0, 1, 7, 10, 11, 14, 19, 24, 30, 32], "sens": 0, "layperson": 0, "re": [0, 18, 32], "describ": [0, 3, 18, 19, 24, 29, 30], "what": [0, 14, 32], "ad": [0, 6, 8, 19, 24, 28, 30], "why": 0, "write": [0, 4, 18, 21, 27], "without": [0, 11, 12, 18, 27], "pass": [0, 18, 21, 27, 32], "cover": 0, "sometim": 0, "necessari": 0, "document": [0, 1, 11, 18, 24, 30], "doubt": 0, "err": 0, "side": 0, "includ": [0, 1, 11, 17, 18, 21, 29, 31, 32], "action": [0, 27], "ask": [0, 15, 16, 19, 32], "policyengin": [1, 3, 16, 19, 24, 26, 27, 29, 31, 32], "core": [1, 3, 4, 24, 26, 27, 28, 29, 32], "open": [1, 4], "sourc": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 25, 30], "python": [1, 3, 17, 18, 19, 24, 27, 28, 30, 31, 32], "packag": [1, 10, 18, 19, 27, 30, 31, 32], "power": [1, 17, 26], "s": [1, 4, 6, 11, 15, 18, 19, 28, 29, 30, 31, 32], "tax": [1, 3, 8, 12, 16, 18, 21, 31, 32], "benefit": [1, 3, 8, 15, 18, 21, 30, 31], "microsimul": [1, 4, 26, 28, 29, 32], "model": [1, 3, 4, 10, 18, 19, 26, 29, 32], "It": [1, 3, 4, 19, 31], "fork": [1, 4], "openfisca": [1, 4, 19, 24, 27], "develop": 1, "doe": [1, 4, 14, 18, 19, 21, 28, 31], "simul": [1, 4, 5, 8, 11, 14, 21, 22, 24, 28, 29], "specif": [1, 8, 10, 11, 25, 28, 29], "polici": [1, 3, 18, 19, 28, 29], "instead": [1, 14, 28, 31], "gener": [1, 4, 12, 19, 24, 26, 27, 28, 29, 30, 31, 32], "framework": 1, "current": [1, 12, 19], "uk": [1, 26, 30], "which": [1, 4, 6, 7, 10, 11, 12, 14, 16, 18, 22, 24, 27, 28, 30, 31, 32], "defin": [1, 3, 4, 6, 8, 10, 12, 13, 14, 18, 19, 24, 28, 29, 30, 31, 32], "custom": [1, 25], "logic": [1, 18, 19, 28, 29], "paramet": [1, 2, 3, 4, 6, 7, 8, 11, 16, 18, 19, 20, 21, 22, 24, 26, 28], "data": [1, 7, 11, 12, 18, 19, 21, 24, 26, 28, 29, 30, 32], "requir": [1, 4, 15, 18], "system": [1, 3, 8, 18, 21, 31], "respect": [1, 14, 18, 19], "The": [1, 2, 3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32], "countri": [1, 10, 16, 18, 19, 27, 29, 30, 31, 32], "provid": [1, 4, 8, 14, 18, 26, 27, 30, 32], "A": [1, 2, 3, 4, 6, 11, 12, 13, 16, 18, 19, 21, 24, 29, 30], "set": [1, 8, 11, 12, 14, 18, 19, 20, 22, 24, 25, 26, 27, 28, 30], "entiti": [1, 3, 11, 14, 15, 18, 19, 24, 28, 30, 31, 32], "type": [1, 2, 4, 6, 7, 11, 12, 16, 18, 19, 20, 22, 24, 28, 30], "e": [1, 4, 6, 11, 12, 14, 18, 19, 27, 30, 32], "g": [1, 4, 6, 11, 12, 14, 19, 32], "person": [1, 6, 11, 14, 15, 18, 19, 24, 26, 30, 31, 32], "flat_tax": 1, "rate": [1, 12, 20, 26, 30], "global": 1, "point": [1, 3, 13, 19, 30], "differ": [1, 3, 6, 10, 11, 19, 26, 29, 30], "valu": [1, 2, 4, 5, 7, 8, 11, 12, 13, 14, 16, 18, 19, 20, 22, 24, 26, 27, 28, 31, 32], "time": [1, 4, 11, 12, 13, 30, 32], "period": [1, 3, 4, 5, 7, 8, 11, 12, 14, 16, 18, 19, 22, 24, 26, 29, 30, 31, 32], "variabl": [1, 3, 4, 8, 11, 14, 16, 18, 19, 20, 22, 23, 27, 28, 30, 32], "income_tax": [1, 12, 26, 30, 32], "properti": [1, 4, 11, 13, 14, 18], "depend": [1, 2, 24], "other": [1, 4, 6, 12, 13, 24, 25, 28, 32], "enabl": [1, 28], "user": [1, 28, 32], "calcul": [1, 3, 5, 6, 11, 18, 19, 22, 24, 26, 27, 28, 32], "trace": [1, 18, 27], "comput": [1, 11, 18, 19, 20, 22, 24, 32], "tree": [1, 3, 12, 19, 28, 30, 31], "mani": 1, "helper": [1, 6, 11, 12, 13], "function": [1, 2, 4, 6, 11, 12, 14, 16, 17, 18, 19, 20, 21, 24, 26, 29, 30, 31], "design": 1, "simplifi": 1, "policyengine_cor": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32], "modul": [2, 3, 4, 5, 6, 10, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 28], "contain": [2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 30], "number": [2, 13, 14, 21, 24], "class": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32], "throughout": 2, "rest": 2, "librari": 2, "input": [2, 3, 7, 8, 11, 18, 19, 20, 24, 32], "ndarrai": [2, 7, 14, 18, 20], "none": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 29], "float": [2, 5, 9, 11, 12, 14, 18, 20, 22, 24, 30, 31], "threshold": [2, 12, 20, 30], "union": [2, 4, 5, 7, 11, 12, 14, 18, 30], "object": [2, 3, 4, 5, 6, 9, 11, 12, 14, 16, 18, 19, 22, 24, 30, 31], "sequenc": [2, 3, 4, 18, 19], "choic": [2, 27], "base": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 18, 19, 20, 22, 24, 25, 30], "from": [2, 3, 4, 7, 10, 12, 13, 16, 18, 19, 20, 21, 24, 26, 28, 29, 31, 32], "list": [2, 3, 4, 5, 6, 9, 11, 12, 13, 14, 18, 19, 21, 22, 24, 26, 27, 28, 30, 32], "select": 2, "choos": 2, "possibl": [2, 24, 27, 30], "return": [2, 4, 7, 11, 12, 13, 14, 16, 18, 19, 20, 21, 24, 25, 26, 31, 32], "chosen": 2, "numpi": [2, 7, 20, 24], "rais": [2, 4, 8, 18, 19, 21, 25], "assertionerror": [2, 21], "when": [2, 3, 8, 18, 19, 20, 24, 25, 30], "c": [2, 27], "either": [2, 4, 13, 30], "1": [2, 7, 13, 14, 18, 20, 24, 26, 29, 30, 32], "arrai": [2, 4, 7, 11, 14, 18, 20, 22, 32], "4": [2, 13, 14, 18, 30, 32], "5": [2, 18, 20, 30, 32], "6": [2, 30, 32], "7": [2, 6, 30], "8": [2, 11, 14, 26], "10": [2, 11, 13, 18, 20, 26, 32], "15": [2, 32], "20": [2, 26, 30], "str": [2, 3, 4, 5, 6, 9, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 24, 30], "unicod": 2, "concaten": 2, "two": [2, 5, 8, 14, 29, 30], "anoth": [2, 12, 18, 20, 24, 32], "2": [2, 7, 11, 13, 14, 19, 26, 29, 30, 32], "this1": 2, "0": [2, 6, 7, 14, 16, 18, 19, 20, 22, 24, 26, 29, 32], "that2": 2, "condit": [2, 14], "value_by_condit": 2, "dict": [2, 4, 5, 11, 12, 16, 18, 19, 21, 24, 28, 30, 32], "mimick": 2, "statement": 2, "given": [2, 4, 11, 12, 13, 14, 18, 19, 20, 24, 27, 29, 30, 32], "same": [2, 8, 16, 19, 28, 29, 30, 31, 32], "size": [2, 13], "replac": [2, 12, 16, 19, 24, 28], "item": [2, 7], "match": [2, 8, 11, 18, 20, 24], "empti": 2, "80": 2, "90": 2, "country_templ": [3, 18, 28, 29, 32], "intend": [3, 10], "start": [3, 12, 13, 22, 24, 26, 31], "new": [3, 4, 9, 10, 11, 12, 13, 16, 19, 20, 28, 31], "To": [3, 10, 11, 18, 27, 28, 29, 30, 31, 32], "creat": [3, 4, 10, 13, 16, 18, 26], "simpli": [3, 10, 19], "copi": [3, 10, 11, 18, 28], "content": [3, 10], "repo": [3, 10, 18, 30], "renam": [3, 7, 10], "folder": [3, 10, 18, 28, 30], "name": [3, 4, 8, 10, 12, 16, 18, 19, 20, 22, 24, 29, 30, 31, 32], "remov": [3, 4, 9, 10, 11, 12, 27, 31], "starter": [3, 10], "code": [3, 8, 10, 24, 26, 27, 28, 30, 32], "option": [3, 4, 5, 6, 7, 9, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 27, 31, 32], "reform": [3, 18, 19, 24, 26, 27, 28], "taxbenefitsystem": [3, 8, 16, 18, 21, 28], "auto_carry_over_input_vari": [3, 19, 28], "bool": [3, 4, 5, 6, 11, 12, 13, 14, 18, 19, 20, 24, 30], "fals": [3, 4, 5, 6, 11, 12, 14, 18, 19, 20, 22, 24, 27, 28, 30], "whether": [3, 4, 18, 19, 24, 30], "carri": [3, 19], "over": [3, 12, 18, 19, 30, 31], "group_ent": [3, 6], "groupent": [3, 14], "modelled_polici": [3, 19], "posixpath": 3, "home": 3, "runner": [3, 17], "work": [3, 32], "filepath": [3, 19], "metadata": [3, 4, 12, 19, 24, 28, 29], "parameters_dir": [3, 19, 28], "directori": [3, 11, 12, 19, 21, 27, 28], "variables_dir": [3, 19, 28], "origin": [4, 11, 18], "standardis": [4, 29], "definit": [4, 7, 8, 11, 16, 18, 19, 24, 25, 28, 32], "instanti": [4, 12, 28, 29], "nation": 4, "lower": [4, 26], "repres": [4, 6, 7, 11, 18, 19, 20, 22, 23, 30, 32], "directli": [4, 28], "indirectli": 4, "common": [4, 29, 32], "storag": [4, 29], "load": [4, 12, 19, 27, 29, 32], "tabl": [4, 27], "time_period_arrai": [4, 29], "data_format": [4, 29], "format": [4, 13, 19, 24, 29, 32], "store": [4, 5, 11, 18, 19, 24, 29, 30], "collect": [4, 30], "per": [4, 30], "datafram": [4, 18, 26], "download": [4, 27, 29], "url": [4, 29, 30], "path": [4, 8, 19, 21, 24, 27, 28], "exist": [4, 10, 14, 18, 19, 31, 32], "check": [4, 11, 12, 14, 18, 28, 32], "file_path": [4, 12, 16, 19], "year": [4, 13, 24, 26, 29, 30, 31], "implement": [4, 12, 16, 28, 30], "method": [4, 11, 14, 16, 18, 29, 30, 31, 32], "notimplementederror": 4, "been": [4, 8, 11, 12, 18, 19, 24], "overriden": 4, "label": [4, 6, 24, 29, 30, 31], "log": [4, 22, 28], "kei": [4, 6, 13, 18, 24, 32], "dictionari": [4, 13, 16, 18, 19, 24, 32], "mode": [4, 22], "r": [4, 18, 27], "hdfstore": 4, "h5": 4, "reader": 4, "access": [4, 12], "2022": [4, 29, 32], "default": [4, 5, 11, 14, 18, 19, 22, 24, 26, 27, 28, 29, 31, 32], "h5py": 4, "np": [4, 7, 18], "pd": [4, 18], "load_dataset": 4, "disk": [4, 5, 25], "filenam": 4, "save": 4, "overwrit": [4, 18], "save_dataset": 4, "example_data": 4, "employment_incom": 4, "25000": 4, "30000": 4, "store_fil": 4, "move": [4, 30], "time_period": [4, 32], "enter": 4, "correct": 4, "data_storag": 5, "handl": [5, 13, 18, 32], "in_memory_storag": 5, "is_etern": 5, "low": 5, "level": 5, "respons": [5, 28, 32], "retriev": 5, "vector": [5, 12, 14, 22], "memori": [5, 11, 18], "clone": [5, 11, 12, 14, 18], "delet": [5, 18], "branch_nam": [5, 11, 22], "get": [5, 11, 14, 18, 19, 24], "_supportsarrai": [5, 11, 12, 14, 18], "dtype": [5, 7, 11, 12, 14, 18, 24, 32], "_nestedsequ": [5, 11, 12, 14, 18], "int": [5, 7, 11, 12, 13, 14, 18, 20, 24, 29, 30], "complex": [5, 11, 12, 14, 18], "byte": [5, 11, 12, 14, 18], "get_known_branch_period": [5, 11], "get_known_period": [5, 11, 18], "get_memory_usag": [5, 11, 14, 18], "put": 5, "on_disk_storag": 5, "storage_dir": 5, "preserve_storage_dir": 5, "restor": [5, 21], "how": [6, 12, 18, 28, 29, 31, 32], "group": [6, 14, 18, 32], "plural": [6, 18, 32], "doc": [6, 24, 32], "household": [6, 7, 14, 18, 24, 29], "etc": [6, 11], "check_role_valid": 6, "check_variable_defined_for_ent": 6, "variable_nam": [6, 8, 14, 18, 19, 31, 32], "get_vari": [6, 19], "check_exist": [6, 19], "set_tax_benefit_system": 6, "tax_benefit_system": [6, 8, 18, 19, 21, 24], "containing_ent": 6, "sever": [6, 24], "identifi": [6, 7, 16, 30], "pluralis": 6, "summari": 6, "full": [6, 30, 32], "whose": [6, 7, 11, 14, 18, 20, 30], "member": [6, 14, 32], "guarante": 6, "superset": 6, "version": [6, 9, 19], "35": 6, "allow": [6, 12, 15, 24], "entir": [6, 22, 24, 27, 30], "relat": [6, 15, 28, 30], "between": [6, 11, 26, 30], "instanc": [6, 7, 11, 12, 13, 15, 16, 18, 19, 20, 24], "is_person": 6, "indexed_enum": 7, "enumer": 7, "specifi": [7, 14, 18, 27, 29, 31, 32], "categor": [7, 24], "enum34": 7, "index": [7, 12, 18, 19, 24, 26, 30], "classmethod": [7, 24], "encod": 7, "string": [7, 18, 24], "string_arrai": 7, "item_1": 7, "item_2": 7, "item_3": 7, "encoded_arrai": 7, "myenum": 7, "3": [7, 13, 14, 22, 30, 32], "int8": 7, "item_arrai": 7, "enum_arrai": 7, "input_arrai": 7, "int_": [7, 20], "possible_valu": [7, 24], "subclass": [7, 16, 19, 29], "improv": 7, "perform": [7, 27], "decod": [7, 18], "object_": 7, "correspond": [7, 24], "self": [7, 13, 16, 19, 25, 26, 29, 30, 31], "housing_occupancy_statu": 7, "housingoccupancystatu": 7, "free_lodg": 7, "lodger": 7, "decode_to_str": 7, "str_": 7, "nan_creation_error": 8, "except": [8, 19, 25], "parameter_not_found_error": 8, "instant_str": [8, 12], "attributeerror": 8, "parameter_parsing_error": 8, "messag": 8, "traceback": [8, 32], "cannot": [8, 32], "pars": 8, "period_mismatch_error": 8, "definition_period": [8, 11, 18, 24, 31], "valueerror": [8, 18], "tri": 8, "doesn": 8, "its": [8, 11, 14, 19, 24, 30, 31], "situation_parsing_error": 8, "situat": [8, 18, 28, 32], "spiral_error": 8, "variable_name_conflict_error": 8, "variable_not_found_error": 8, "queri": 8, "hous": 9, "aren": 9, "fulli": [9, 18], "stabl": 9, "yet": 9, "mai": [9, 11, 18], "futur": 9, "memory_config": [9, 18], "max_memory_occup": 9, "priority_vari": 9, "variables_to_drop": 9, "extension_templ": 10, "plugin": 10, "rather": 10, "than": [10, 19, 26, 30], "standalon": 10, "initialis": [10, 18], "unlik": [10, 18], "must": [10, 12, 14, 16, 19, 24, 28, 29, 30, 31], "countrytaxbenefitsystem": [10, 18, 28], "keep": [11, 20], "track": [11, 22], "after": [11, 30], "thei": [11, 30], "just": [11, 18, 29, 32], "enough": [11, 18], "abl": [11, 12, 18, 29, 31], "modifi": [11, 12, 16, 18], "create_disk_storag": 11, "preserv": 11, "ondiskstorag": 11, "default_arrai": 11, "appropri": 11, "length": [11, 24], "fill": 11, "delete_arrai": [11, 18], "known": [11, 18], "onli": [11, 14, 19, 22, 24, 27, 32], "2017": [11, 13], "01": [11, 12, 13, 14, 24, 26, 29, 30, 31, 32], "07": 11, "would": [11, 32], "get_arrai": [11, 18], "tupl": [11, 13, 18, 24], "virtual": [11, 18], "usag": [11, 18, 24, 27, 32], "nb_arrai": 11, "12": [11, 13, 18, 26], "nb_cells_by_arrai": 11, "100": [11, 20, 22, 29, 31], "There": [11, 18], "cell_siz": 11, "take": [11, 16, 19, 24, 31], "8b": 11, "float64": [11, 20], "64": 11, "total_nb_byt": 11, "10400": 11, "4kb": 11, "nb_request": 11, "24": [11, 30], "nb_requests_by_arrai": 11, "averag": [11, 20, 22], "request": [11, 12, 19], "twice": 11, "put_in_cach": 11, "set_input": [11, 18, 24], "14": [11, 18], "2018": [11, 14, 18], "04": [11, 18, 30], "accept": [11, 18], "read": [11, 18], "declar": [11, 32], "attribut": [11, 18, 19, 24], "In": [11, 12, 16, 31], "case": [11, 12, 18, 28, 29, 30, 31, 32], "larger": [11, 18], "appli": [11, 12, 16, 19, 20, 26, 27, 28, 30, 31], "subperiod": 11, "divid": 11, "mainli": 12, "revolv": 12, "around": 12, "instant": [12, 18, 19, 26, 30, 31], "pattern": 12, "evalu": [12, 30], "legisl": [12, 16, 19, 24, 30], "values_list": 12, "revers": [12, 14], "chronolog": 12, "order": [12, 14], "some_tax": [12, 16], "some_param": [12, 16], "wa": 12, "2015": [12, 13], "550": 12, "2016": [12, 18], "600": 12, "incom": [12, 26, 32], "salari": [12, 14, 18, 29, 32], "refer": [12, 24, 29], "http": [12, 19, 24, 30], "gov": [12, 26, 30], "get_descend": 12, "mark_as_modifi": 12, "updat": [12, 16, 19, 26, 31], "stop": [12, 13, 26, 31], "where": [12, 13, 18, 24, 30], "parameter_nod": 12, "directory_path": 12, "node": [12, 20], "add_child": [12, 16], "child": [12, 14, 15, 29, 30], "anyth": 12, "could": [12, 32], "interfer": 12, "oper": 12, "dot": 12, "attach_to_par": 12, "parent": [12, 14, 15, 18, 22, 29], "clear_parent_cach": 12, "iter": [12, 13, 18], "recurs": [12, 19, 21], "merg": 12, "conflict": 12, "root": 12, "parameter_at_inst": 12, "valid": [12, 24, 29], "parameter_node_at_inst": [12, 22], "child_nam": 12, "child_at_inst": 12, "parameter_scal": 12, "scale": 12, "margin": [12, 20], "propagate_unit": 12, "propagate_upr": 12, "parameter_scale_bracket": 12, "bracket": [12, 20], "static": [12, 16], "allowed_unit_kei": 12, "uprat": [12, 24, 30], "at_instant_lik": 12, "abc": [12, 20], "variou": [12, 20], "protocol": 12, "get_at_inst": 12, "vectorial_parameter_node_at_inst": 12, "housing_benefit": 12, "zipcod": 12, "build_from_nod": 12, "check_node_vectoris": 12, "cast": 12, "vectori": 12, "fanci": 12, "interv": [13, 30], "instant_": 13, "convert": 13, "2014": 13, "datetim": 13, "dai": [13, 24], "extract": [13, 18], "month": [13, 18, 24, 29], "offset": 13, "unit": [13, 20, 24], "increment": 13, "decrement": 13, "31": [13, 26], "28": 13, "2011": 13, "2012": 13, "29": [13, 26], "2013": 13, "30": [13, 26, 32], "first": [13, 18], "last": [13, 30, 32], "period_": 13, "toolbox": 13, "tripl": 13, "integ": [13, 18, 20], "sinc": 13, "true": [13, 14, 18, 19, 22, 24, 30], "count": [13, 18, 32], "365": 13, "first_dai": 13, "first_month": 13, "get_subperiod": 13, "02": [13, 30], "intersect": 13, "last_3_month": 13, "last_month": 13, "last_year": 13, "n_2": 13, "2010": 13, "size_in_dai": 13, "366": 13, "size_in_month": 13, "this_year": 13, "aka": 13, "start_inst": [13, 30], "peopl": [14, 18, 32], "check_array_compatible_with_ent": 14, "check_period_valid": 14, "empty_arrai": 14, "filled_arrai": 14, "get_hold": [14, 18], "holder": [14, 18], "get_index": 14, "id": [14, 16, 32], "get_rank": 14, "criteria": 14, "rank": 14, "accord": 14, "minimum": [14, 22], "who": [14, 32], "taken": 14, "account": 14, "ag": [14, 18, 26, 32], "32": 14, "34": 14, "is_child": 14, "has_rol": 14, "sort": 14, "so": [14, 21, 32], "eldest": 14, "role": [14, 15, 18, 32], "value_from_partn": 14, "group_popul": [14, 18], "dimens": 14, "2000": [14, 18], "1500": 14, "1800": 14, "get_rol": [14, 18], "role_nam": 14, "max": [14, 24, 27, 32], "maximum": [14, 22], "members_entity_id": 14, "members_posit": 14, "members_rol": 14, "min": [14, 27, 32], "assum": [14, 20], "1st": 14, "nb_person": [14, 18], "ordered_members_map": 14, "mask": 14, "cach": [14, 18, 24], "map": [14, 18], "value_nth_person": 14, "reduc": 14, "callabl": [14, 16, 19, 24], "neutral_el": 14, "sum": [14, 20, 26, 32], "3500": 14, "value_from_first_person": 14, "value_from_person": 14, "uniqu": 14, "result": [14, 18, 32], "n": [14, 27], "posit": [14, 18], "arbitrari": 14, "nth": 14, "formula": [15, 18, 24, 31], "question": 15, "particular": [15, 30, 32], "might": [15, 30, 32], "earn": 15, "said": 15, "famili": [15, 30], "grouppopul": [15, 18], "famil": 15, "first_person": 15, "declarant_princip": 15, "edit": 16, "baselin": [16, 18, 26], "call": [16, 19, 32], "modify_paramet": [16, 19, 26, 31], "import": [16, 18, 20, 26, 28, 29, 31, 32], "load_parameter_fil": 16, "def": [16, 26, 29, 31], "modify_my_paramet": 16, "new_paramet": 16, "reform_nam": 16, "path_to_yaml_fil": 16, "some_period": 16, "1000": 16, "myreform": 16, "add_vari": [16, 19, 31], "some_vari": 16, "update_vari": [16, 19, 31], "some_other_vari": 16, "modifier_funct": [16, 19], "country_id": 16, "inform": [16, 30], "api": [16, 28], "from_api": 16, "api_id": 16, "pair": 16, "from_dict": 16, "parameter_valu": 16, "parameternod": [16, 19, 22, 31], "modif": [16, 19], "ui": 16, "command": 17, "line": [17, 24, 32], "interfac": [17, 32], "singular": 18, "most": [18, 28, 29, 31, 32], "combin": 18, "unknown": [18, 32], "varieti": 18, "json": [18, 24, 28], "dataset": [18, 24, 27, 28, 32], "apply_reform": [18, 19], "build_from_dataset": 18, "build_from_popul": 18, "pre": 18, "map_to": [18, 26], "decode_enum": 18, "arraylik": 18, "calculate_add": 18, "calculate_datafram": 18, "calculate_divid": 18, "calculate_output": 18, "clear_macro_cach": 18, "clear": 18, "debug": 18, "clone_tax_benefit_system": 18, "create_shortcut": 18, "data_storage_dir": 18, "temporari": 18, "intermedi": 18, "satur": 18, "avail": [18, 27, 28, 29], "default_calculation_period": 18, "default_dataset": [18, 28], "default_input_period": 18, "default_rol": 18, "assign": 18, "default_tax_benefit_system": [18, 28], "default_tax_benefit_system_inst": 18, "slow": 18, "down": 18, "speed": [18, 26], "up": [18, 22, 26, 27], "individu": [18, 25], "05": [18, 30], "13": [18, 24], "int32": 18, "deriv": 18, "wrt": 18, "delta": 18, "w": 18, "differenti": 18, "infinitesim": 18, "describe_ent": 18, "extract_person": 18, "exclude_ent": 18, "state": [18, 30], "alreai": 18, "previous": [18, 19], "trigger": 18, "get_branch": 18, "branch": [18, 24], "clone_system": 18, "get_ent": 18, "associ": 18, "i": [18, 27, 30], "initi": 18, "u": 18, "get_popul": 18, "get_variable_popul": 18, "invalidate_cache_entri": 18, "invalidate_spiral_vari": 18, "is_over_dataset": 18, "built": [18, 19], "link_to_entities_inst": 18, "macro_cache_read": 18, "macro": 18, "macro_cache_writ": 18, "map_result": 18, "source_ent": 18, "target_ent": 18, "arr": 18, "target": 18, "invalid": 18, "di": 18, "aggreg": [18, 22, 27], "purge_cache_of_invalid_valu": 18, "sample_person": 18, "sampl": 18, "weight": [18, 29, 32], "use_weight": 18, "microseri": [18, 32], "microdatafram": 18, "get_weight": 18, "max_spiral_loop": 18, "memoryconfig": [18, 25], "opt_out_cach": 18, "tracer": 18, "simpletrac": 18, "simulation_build": 18, "add_default_group_ent": 18, "persons_id": 18, "add_group_ent": 18, "persons_plur": 18, "instances_json": 18, "add_parallel_axi": 18, "axi": 18, "add_perpendicular_axi": 18, "add_person_ent": 18, "add_variable_valu": 18, "instance_index": 18, "instance_id": 18, "period_str": 18, "build_default_simul": 18, "everi": 18, "build_from_dict": 18, "input_dict": 18, "build_from_ent": 18, "build_from_vari": 18, "javier": 18, "11": [18, 26], "explicit": [18, 19], "infer": 18, "structur": [18, 28, 30, 32], "12000": 18, "check_persons_to_alloc": 18, "entity_plur": 18, "person_id": [18, 29], "entity_id": 18, "role_id": 18, "persons_to_alloc": 18, "create_ent": 18, "declare_ent": 18, "entity_singular": 18, "declare_person_ent": 18, "person_singular": 18, "expand_ax": 18, "explicit_singular_ent": 18, "preprocess": 18, "singl": [18, 20, 30, 32], "shortcut": 18, "finalize_variables_init": 18, "get_count": 18, "entity_nam": 18, "get_id": 18, "get_input": 18, "get_membership": 18, "get_variable_ent": 18, "init_variable_valu": 18, "instance_object": 18, "join_with_person": 18, "persons_group_assign": 18, "raise_period_mismatch": 18, "register_vari": 18, "set_default_period": 18, "everyon": [19, 32], "some": 19, "add_modelled_policy_metadata": 19, "error": [19, 27, 31], "variablenameconflicterror": 19, "add_variable_metadata_from_fold": 19, "readm": 19, "md": 19, "add_variables_from_directori": 19, "explor": [19, 21], "add_variables_from_fil": 19, "reform_path": 19, "mutat": 19, "installed_packag": 19, "sub_modul": 19, "openfisca_fr": 19, "inversion_revenu": 19, "basic_input": 19, "short": [19, 30], "basic": [19, 30], "medium": 19, "accuraci": 19, "get_package_metadata": 19, "metatada": 19, "rel": 19, "locat": 19, "dir": 19, "franc": 19, "repository_url": 19, "com": 19, "17": [19, 32], "get_parameters_at_inst": 19, "parameternodeatinst": 19, "yyyi": [19, 24], "mm": [19, 24], "dd": [19, 24], "load_extens": 19, "extens": [19, 27], "absolut": 19, "instal": [19, 25, 27], "pip": 19, "load_paramet": 19, "path_to_yaml_dir": 19, "toward": [19, 21], "neutralize_vari": [19, 31], "neutral": [19, 24, 31], "alwai": 19, "try": 19, "effect": [19, 27], "warn": 19, "replace_vari": 19, "overridden": [19, 30], "stai": 19, "unchang": 19, "taxscal": 20, "numer": 20, "tax_scale_lik": 20, "amount": [20, 30, 31], "rate_tax_scale_lik": 20, "linear": 20, "bracket_indic": 20, "tax_bas": 20, "numericalarrai": 20, "factor": 20, "round_decim": 20, "relev": [20, 30], "indic": [20, 30], "decim": 20, "round": [20, 30], "tax_scal": 20, "add_bracket": 20, "150": 20, "threshold_from_tax_bas": 20, "param": 20, "200": [20, 29], "500": [20, 32], "25": [20, 26], "450": 20, "1_150": 20, "abstract_tax_scal": 20, "abstract_rate_tax_scal": 20, "amount_tax_scale_lik": 20, "single_amount_tax_scal": 20, "calc": 20, "right": 20, "float_": 20, "cell": [20, 32], "fit": 20, "marginal_rate_tax_scal": 20, "round_base_decim": 20, "invers": 20, "invert": 20, "compos": 20, "express": [20, 30, 32], "term": 20, "gross": 20, "revenu": 20, "net": [20, 26], "gross_revenu": 20, "Then": [20, 32], "marginal_r": 20, "rate_from_bracket_indic": 20, "int64": 20, "50": [20, 26], "1_000": 20, "250": 20, "rate_from_tax_bas": 20, "scale_tax_scal": 20, "marginal_amount_tax_scal": 20, "lowest": 20, "linear_average_rate_tax_scal": 20, "miscellan": 21, "util": [21, 26], "test_runn": 21, "subdirectori": 21, "detail": 21, "below": [21, 26], "sucess": 21, "excecut": 21, "simulation_dump": 21, "later": 21, "kwarg": 21, "involv": 22, "computation_log": 22, "full_trac": 22, "print_log": 22, "max_depth": [22, 27], "print": 22, "suit": 22, "larg": [22, 28], "depth": [22, 27], "flat_trac": 22, "performance_log": 22, "simple_trac": 22, "trace_nod": 22, "children": [22, 30], "factori": 22, "end": [22, 24], "tracing_parameter_node_at_inst": 22, "well": [24, 32], "baseline_vari": 24, "altern": 24, "org": 24, "concept": 24, "html": [24, 27], "_": 24, "introduc": 24, "default_valu": 24, "defined_for": 24, "nonzero": 24, "etern": [24, 29], "35_period": 24, "multilin": 24, "text": [24, 30], "context": 24, "scipi": 24, "under": [24, 26, 32], "hood": 24, "40_legislation_evolut": 24, "disappear": 24, "_entiti": 24, "_role": 24, "exhaustive_parameter_depend": 24, "plu": 24, "haven": 24, "get_formula": 24, "oldest": 24, "get_introspection_data": 24, "instrospect": 24, "comment": 24, "hidden_input": 24, "hidden": 24, "screen": 24, "index_in_modul": 24, "is_input_vari": 24, "is_neutr": 24, "never": 24, "json_typ": 24, "max_length": 24, "limit": 24, "module_nam": 24, "parse_formula_nam": 24, "attribute_nam": 24, "formula_yyyi": 24, "formula_yyyy_mm": 24, "formula_yyyy_mm_dd": 24, "By": 24, "convent": 24, "0001": 24, "minim": 24, "enumarrai": 24, "enum": [24, 30], "quantity_typ": 24, "stock": 24, "flow": 24, "requires_computation_aft": 24, "set_input_dispatch_by_period": 24, "set_input_divide_by_period": 24, "noth": 24, "subtract": 24, "value_typ": [24, 31], "userwarn": 25, "libyaml": 25, "with_traceback": 25, "tb": 25, "__traceback__": 25, "tempfil": 25, "visualis": 26, "analys": 26, "These": 26, "style": 26, "bar_chart": 26, "export": 26, "policyengine_uk": 26, "hmrc": 26, "2023": 26, "2028": 26, "baseline_incom": 26, "household_net_incom": 26, "reformed_incom": 26, "gain": 26, "decil": 26, "household_income_decil": 26, "decile_impact": 26, "groupbi": 26, "display_fig": [26, 32], "titl": [26, 32], "xaxis_titl": [26, 32], "yaxis_titl": [26, 32], "xaxis_tickv": 26, "rang": [26, 30], "yaxis_tickformat": [26, 32], "text_format": 26, "hover_text_funct": 26, "lambda": 26, "x": [26, 30, 32], "y": [26, 30, 32], "f": 26, "cardin": 26, "show": [26, 32], "distribut": 26, "outcom": 26, "along": 26, "breakdown": [26, 30], "lower_age_group": 26, "personal_gain": 26, "cross_section_bar_chart": 26, "slice": 26, "xaxis_tickformat": [26, 32], "category_nam": 26, "lose": 26, "experi": 26, "less": [26, 30], "yaxis_ticktext": 26, "19": [26, 32], "39": 26, "40": 26, "49": 26, "59": 26, "60": 26, "69": 26, "70": 26, "79": 26, "color_discrete_map": 26, "dark_grai": 26, "medium_dark_grai": 26, "grai": 26, "light_grai": 26, "blue": [26, 32], "legend_orient": 26, "h": [26, 27], "legend_i": 26, "percent": [26, 30], "0f": [26, 32], "old": 26, "tool": 27, "manag": 27, "country_packag": 27, "name_filt": 27, "p": 27, "graph": 27, "v": 27, "o": 27, "only_vari": 27, "ignore_vari": 27, "execut": 27, "detect": 27, "attempt": 27, "scan": 27, "environ": 27, "word": 27, "partial": 27, "keyword": 27, "pdb": 27, "drop": 27, "debugg": 27, "failur": 27, "output": 27, "performance_graph": 27, "csv": 27, "verbos": 27, "increas": [27, 30], "avg": 27, "flag": 27, "maxim": 27, "ignor": 27, "upload": [27, 29], "focu": 27, "addit": 27, "won": 28, "interact": 28, "those": 28, "hold": [28, 30], "purpos": [28, 32], "country_dir": [28, 29], "ll": [28, 31, 32], "want": [28, 31, 32], "follow": [28, 30, 32], "arbitrarili": 28, "organis": 28, "usabl": 28, "situation_exampl": 28, "quickli": 28, "demonstr": 28, "py": [28, 32], "__init__": [28, 32], "main": 28, "block": 28, "abov": [28, 30], "inherit": [28, 31, 32], "here": [28, 29, 30, 31, 32], "os": 28, "coupl": 28, "coresimul": 28, "coremicrosimul": 28, "country_template_dataset": [28, 29], "countrytemplatedataset": [28, 29], "pathlib": 28, "constant": [28, 29], "few": [29, 32], "thousand": 29, "form": [29, 30], "survei": [29, 32], "techniqu": 29, "impact": 29, "compar": 29, "we": [29, 32], "templat": 29, "folder_path": 29, "raw": 29, "household_id": 29, "person_household_id": 29, "person_household_rol": 29, "salary_time_period": 29, "1e6": [29, 32], "2e6": 29, "weight_time_period": 29, "household_weight": 29, "save_variable_valu": 29, "dynam": 29, "publicdataset": 29, "publicli": 29, "privatedataset": 29, "privat": 29, "googl": 29, "cloud": 29, "bucket": 29, "subnod": 30, "child_benefit": [30, 31], "national_insur": 30, "employe": 30, "universal_credit": 30, "achiev": 30, "histori": 30, "2019": [30, 31, 32], "00": 30, "21": 30, "03": 30, "22": 30, "23": 30, "while": 30, "freeform": 30, "schema": 30, "data_structur": 30, "ensur": [30, 31], "consist": 30, "better": 30, "currenc": 30, "gbp": 30, "href": [30, 32], "www": 30, "govern": 30, "public": 30, "parametermetadata": 30, "longer": 30, "mean": 30, "displai": 30, "sentenc": 30, "snake": 30, "safe": 30, "real": 30, "world": 30, "upratingindex": 30, "upratingschema": 30, "look": 30, "forward": 30, "z": 30, "parameternodemetadata": 30, "variablebreakdown": 30, "dynamicbreakdown": 30, "grandchildren": 30, "further": 30, "descend": 30, "region": 30, "england": 30, "wale": 30, "eval": 30, "uat": 30, "produc": 30, "great": 30, "unless": 30, "propagate_metadata_to_children": 30, "propag": 30, "exclud": 30, "piec": 30, "link": 30, "eur": 30, "euro": 30, "british": 30, "pound": 30, "sterl": 30, "percentag": 30, "usd": 30, "dollar": 30, "parameter_metadata": 30, "selfupr": 30, "special": 30, "upratingroundingconfig": 30, "nearest": 30, "upward": 30, "downward": 30, "configur": 30, "parameter_node_metadata": 30, "wai": 31, "new_variable_class": 31, "overriding_variable_class": 31, "everyth": [31, 32], "new_vari": 31, "argument": 31, "throw": 31, "alreadi": 31, "overrid": 31, "zero": 31, "essenti": 31, "law": 32, "repositori": 32, "page": 32, "simpl": 32, "meet": 32, "30_000": 32, "4500": 32, "float32": 32, "three": 32, "often": 32, "perpendicular": 32, "parallel": 32, "vari": 32, "100_000": 32, "1666": 32, "6667": 32, "3333": 32, "3335": 32, "5000": 32, "6666": 32, "667": 32, "8333": 32, "334": 32, "10000": 32, "11666": 32, "668": 32, "13333": 32, "15000": 32, "001": 32, "plotli": 32, "px": 32, "chart": 32, "format_fig": 32, "fig": 32, "color_discrete_sequ": 32, "update_layout": 32, "xaxis_tickprefix": 32, "yaxis_tickprefix": 32, "update_trac": 32, "hovertempl": 32, "b": 32, "br": 32, "importerror": 32, "recent": 32, "nikhil": 32, "ipynb": 32, "vscode": 32, "notebook": 32, "x11szmlszq": 32, "3d": 32, "16": 32, "18": 32, "As": 32, "weightedsimul": 32, "former": 32, "latter": 32, "sim": 32, "51": 32, "000003242492674": 32, "inspect": 32, "actual": 32, "microdf": 32, "panda": 32, "seri": 32, "extra": 32, "intuit": 32, "treat": 32, "were": 32}, "objects": {"policyengine_core.commons.formulas": [[2, 0, 1, "", "apply_thresholds"], [2, 0, 1, "", "concat"], [2, 0, 1, "", "switch"]], "policyengine_core.country_template": [[3, 1, 1, "", "CountryTaxBenefitSystem"]], "policyengine_core.country_template.CountryTaxBenefitSystem": [[3, 2, 1, "", "auto_carry_over_input_variables"], [3, 2, 1, "", "entities"], [3, 2, 1, "", "modelled_policies"], [3, 2, 1, "", "parameters_dir"], [3, 2, 1, "", "variables_dir"]], "policyengine_core.data": [[4, 1, 1, "", "Dataset"]], "policyengine_core.data.Dataset": [[4, 2, 1, "", "ARRAYS"], [4, 2, 1, "", "TABLES"], [4, 2, 1, "", "TIME_PERIOD_ARRAYS"], [4, 2, 1, "", "data_format"], [4, 3, 1, "", "download"], [4, 4, 1, "", "exists"], [4, 2, 1, "", "file_path"], [4, 3, 1, "", "generate"], [4, 2, 1, "", "label"], [4, 3, 1, "", "load"], [4, 3, 1, "", "load_dataset"], [4, 2, 1, "", "name"], [4, 3, 1, "", "remove"], [4, 3, 1, "", "save"], [4, 3, 1, "", "save_dataset"], [4, 3, 1, "", "store_file"], [4, 2, 1, "", "time_period"], [4, 2, 1, "", "url"], [4, 4, 1, "", "variables"]], "policyengine_core.data_storage.in_memory_storage": [[5, 1, 1, "", "InMemoryStorage"]], "policyengine_core.data_storage.in_memory_storage.InMemoryStorage": [[5, 3, 1, "", "clone"], [5, 3, 1, "", "delete"], [5, 3, 1, "", "get"], [5, 3, 1, "", "get_known_branch_periods"], [5, 3, 1, "", "get_known_periods"], [5, 3, 1, "", "get_memory_usage"], [5, 2, 1, "", "is_eternal"], [5, 3, 1, "", "put"]], "policyengine_core.data_storage.on_disk_storage": [[5, 1, 1, "", "OnDiskStorage"]], "policyengine_core.data_storage.on_disk_storage.OnDiskStorage": [[5, 3, 1, "", "delete"], [5, 3, 1, "", "get"], [5, 3, 1, "", "get_known_branch_periods"], [5, 3, 1, "", "get_known_periods"], [5, 3, 1, "", "put"], [5, 3, 1, "", "restore"]], "policyengine_core.data_structures": [[30, 1, 1, "", "ParameterMetadata"], [30, 1, 1, "", "ParameterNodeMetadata"], [30, 1, 1, "", "Reference"], [30, 1, 1, "", "Unit"], [30, 5, 0, "-", "parameter_metadata"], [30, 5, 0, "-", "parameter_node_metadata"]], "policyengine_core.data_structures.ParameterMetadata": [[30, 2, 1, "", "description"], [30, 2, 1, "", "documentation"], [30, 2, 1, "", "label"], [30, 2, 1, "", "name"], [30, 2, 1, "", "reference"], [30, 2, 1, "", "unit"], [30, 2, 1, "", "uprating"]], "policyengine_core.data_structures.ParameterNodeMetadata": [[30, 2, 1, "", "breakdown"], [30, 2, 1, "", "label"], [30, 2, 1, "", "name"], [30, 2, 1, "", "propagate_metadata_to_children"], [30, 2, 1, "", "reference"]], "policyengine_core.data_structures.Reference": [[30, 2, 1, "", "href"], [30, 2, 1, "", "label"], [30, 2, 1, "", "type"]], "policyengine_core.data_structures.Unit": [[30, 2, 1, "", "EUR"], [30, 2, 1, "", "GBP"], [30, 2, 1, "", "PERCENT"], [30, 2, 1, "", "USD"]], "policyengine_core.data_structures.parameter_metadata": [[30, 1, 1, "", "SelfUprating"], [30, 1, 1, "", "UpratingIndex"], [30, 1, 1, "", "UpratingRoundingConfig"], [30, 1, 1, "", "UpratingSchema"]], "policyengine_core.data_structures.parameter_metadata.UpratingRoundingConfig": [[30, 2, 1, "", "interval"], [30, 2, 1, "", "type"]], "policyengine_core.data_structures.parameter_metadata.UpratingSchema": [[30, 2, 1, "", "parameter"], [30, 2, 1, "", "start_instant"], [30, 2, 1, "", "type"]], "policyengine_core.data_structures.parameter_node_metadata": [[30, 1, 1, "", "DynamicBreakdown"], [30, 1, 1, "", "VariableBreakdown"]], "policyengine_core.entities.entity": [[6, 1, 1, "", "Entity"]], "policyengine_core.entities.entity.Entity": [[6, 3, 1, "", "check_role_validity"], [6, 3, 1, "", "check_variable_defined_for_entity"], [6, 3, 1, "", "get_variable"], [6, 3, 1, "", "set_tax_benefit_system"]], "policyengine_core.entities.group_entity": [[6, 1, 1, "", "GroupEntity"]], "policyengine_core.entities.helpers": [[6, 0, 1, "", "build_entity"]], "policyengine_core.entities.role": [[6, 1, 1, "", "Role"]], "policyengine_core.enums.enum": [[7, 1, 1, "", "Enum"]], "policyengine_core.enums.enum.Enum": [[7, 3, 1, "", "encode"]], "policyengine_core.enums.enum_array": [[7, 1, 1, "", "EnumArray"]], "policyengine_core.enums.enum_array.EnumArray": [[7, 3, 1, "", "decode"], [7, 3, 1, "", "decode_to_str"]], "policyengine_core.errors.nan_creation_error": [[8, 1, 1, "", "NaNCreationError"]], "policyengine_core.errors.parameter_not_found_error": [[8, 1, 1, "", "ParameterNotFoundError"]], "policyengine_core.errors.parameter_parsing_error": [[8, 1, 1, "", "ParameterParsingError"]], "policyengine_core.errors.period_mismatch_error": [[8, 1, 1, "", "PeriodMismatchError"]], "policyengine_core.errors.situation_parsing_error": [[8, 1, 1, "", "SituationParsingError"]], "policyengine_core.errors.spiral_error": [[8, 1, 1, "", "SpiralError"]], "policyengine_core.errors.variable_name_conflict_error": [[8, 1, 1, "", "VariableNameConflictError"]], "policyengine_core.errors.variable_not_found_error": [[8, 1, 1, "", "VariableNotFoundError"]], "policyengine_core.experimental.memory_config": [[9, 1, 1, "", "MemoryConfig"]], "policyengine_core.holders.helpers": [[11, 0, 1, "", "set_input_dispatch_by_period"], [11, 0, 1, "", "set_input_divide_by_period"]], "policyengine_core.holders.holder": [[11, 1, 1, "", "Holder"]], "policyengine_core.holders.holder.Holder": [[11, 3, 1, "", "clone"], [11, 3, 1, "", "create_disk_storage"], [11, 3, 1, "", "default_array"], [11, 3, 1, "", "delete_arrays"], [11, 3, 1, "", "get_array"], [11, 3, 1, "", "get_known_branch_periods"], [11, 3, 1, "", "get_known_periods"], [11, 3, 1, "", "get_memory_usage"], [11, 3, 1, "", "put_in_cache"], [11, 3, 1, "", "set_input"]], "policyengine_core.parameters.at_instant_like": [[12, 1, 1, "", "AtInstantLike"]], "policyengine_core.parameters.at_instant_like.AtInstantLike": [[12, 3, 1, "", "get_at_instant"]], "policyengine_core.parameters.helpers": [[12, 0, 1, "", "contains_nan"], [12, 0, 1, "", "load_parameter_file"]], "policyengine_core.parameters.parameter": [[12, 1, 1, "", "Parameter"]], "policyengine_core.parameters.parameter.Parameter": [[12, 3, 1, "", "clone"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "mark_as_modified"], [12, 3, 1, "", "update"], [12, 2, 1, "", "values_list"]], "policyengine_core.parameters.parameter_at_instant": [[12, 1, 1, "", "ParameterAtInstant"]], "policyengine_core.parameters.parameter_at_instant.ParameterAtInstant": [[12, 3, 1, "", "clone"], [12, 3, 1, "", "validate"]], "policyengine_core.parameters.parameter_node": [[12, 1, 1, "", "ParameterNode"]], "policyengine_core.parameters.parameter_node.ParameterNode": [[12, 3, 1, "", "add_child"], [12, 3, 1, "", "attach_to_parent"], [12, 3, 1, "", "clear_parent_cache"], [12, 3, 1, "", "clone"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "mark_as_modified"], [12, 3, 1, "", "merge"], [12, 2, 1, "", "parent"]], "policyengine_core.parameters.parameter_node_at_instant": [[12, 1, 1, "", "ParameterNodeAtInstant"]], "policyengine_core.parameters.parameter_node_at_instant.ParameterNodeAtInstant": [[12, 3, 1, "", "add_child"]], "policyengine_core.parameters.parameter_scale": [[12, 1, 1, "", "ParameterScale"]], "policyengine_core.parameters.parameter_scale.ParameterScale": [[12, 3, 1, "", "clone"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "propagate_units"], [12, 3, 1, "", "propagate_uprating"]], "policyengine_core.parameters.parameter_scale_bracket": [[12, 1, 1, "", "ParameterScaleBracket"]], "policyengine_core.parameters.parameter_scale_bracket.ParameterScaleBracket": [[12, 3, 1, "", "allowed_unit_keys"], [12, 3, 1, "", "get_descendants"], [12, 3, 1, "", "propagate_uprating"]], "policyengine_core.parameters.vectorial_parameter_node_at_instant": [[12, 1, 1, "", "VectorialParameterNodeAtInstant"]], "policyengine_core.parameters.vectorial_parameter_node_at_instant.VectorialParameterNodeAtInstant": [[12, 3, 1, "", "build_from_node"], [12, 3, 1, "", "check_node_vectorisable"]], "policyengine_core.periods.helpers": [[13, 0, 1, "", "instant"], [13, 0, 1, "", "period"]], "policyengine_core.periods.instant_": [[13, 1, 1, "", "Instant"]], "policyengine_core.periods.instant_.Instant": [[13, 4, 1, "", "date"], [13, 4, 1, "", "day"], [13, 4, 1, "", "month"], [13, 3, 1, "", "offset"], [13, 3, 1, "", "period"], [13, 4, 1, "", "year"]], "policyengine_core.periods.period_": [[13, 1, 1, "", "Period"]], "policyengine_core.periods.period_.Period": [[13, 3, 1, "", "contains"], [13, 4, 1, "", "date"], [13, 4, 1, "", "days"], [13, 4, 1, "", "first_day"], [13, 4, 1, "", "first_month"], [13, 3, 1, "", "get_subperiods"], [13, 3, 1, "", "intersection"], [13, 4, 1, "", "last_3_months"], [13, 4, 1, "", "last_month"], [13, 4, 1, "", "last_year"], [13, 4, 1, "", "n_2"], [13, 3, 1, "", "offset"], [13, 4, 1, "", "size"], [13, 4, 1, "", "size_in_days"], [13, 4, 1, "", "size_in_months"], [13, 4, 1, "", "start"], [13, 4, 1, "", "stop"], [13, 4, 1, "", "this_year"], [13, 4, 1, "", "unit"]], "policyengine_core.populations.group_population": [[14, 1, 1, "", "GroupPopulation"]], "policyengine_core.populations.group_population.GroupPopulation": [[14, 3, 1, "", "all"], [14, 3, 1, "", "any"], [14, 3, 1, "", "clone"], [14, 3, 1, "", "get_role"], [14, 3, 1, "", "max"], [14, 4, 1, "", "members_entity_id"], [14, 4, 1, "", "members_position"], [14, 4, 1, "", "members_role"], [14, 3, 1, "", "min"], [14, 3, 1, "", "nb_persons"], [14, 4, 1, "", "ordered_members_map"], [14, 3, 1, "", "project"], [14, 3, 1, "", "reduce"], [14, 3, 1, "", "sum"], [14, 3, 1, "", "value_from_first_person"], [14, 3, 1, "", "value_from_person"], [14, 3, 1, "", "value_nth_person"]], "policyengine_core.populations.population": [[14, 1, 1, "", "Population"]], "policyengine_core.populations.population.Population": [[14, 3, 1, "", "check_array_compatible_with_entity"], [14, 3, 1, "", "check_period_validity"], [14, 3, 1, "", "clone"], [14, 3, 1, "", "empty_array"], [14, 3, 1, "", "filled_array"], [14, 3, 1, "", "get_holder"], [14, 3, 1, "", "get_index"], [14, 3, 1, "", "get_memory_usage"], [14, 3, 1, "", "get_rank"], [14, 3, 1, "", "has_role"], [14, 3, 1, "", "value_from_partner"]], "policyengine_core.projectors": [[15, 1, 1, "", "EntityToPersonProjector"], [15, 1, 1, "", "FirstPersonToEntityProjector"], [15, 1, 1, "", "Projector"], [15, 1, 1, "", "UniqueRoleToEntityProjector"]], "policyengine_core.reforms": [[16, 1, 1, "", "Reform"]], "policyengine_core.reforms.Reform": [[16, 2, 1, "", "country_id"], [16, 3, 1, "", "from_api"], [16, 3, 1, "", "from_dict"], [16, 3, 1, "", "modify_parameters"], [16, 2, 1, "", "name"], [16, 2, 1, "", "parameter_values"]], "policyengine_core.simulations.microsimulation": [[18, 1, 1, "", "Microsimulation"]], "policyengine_core.simulations.microsimulation.Microsimulation": [[18, 3, 1, "", "apply_reform"], [18, 2, 1, "", "baseline"], [18, 2, 1, "", "branches"], [18, 3, 1, "", "build_from_dataset"], [18, 3, 1, "", "build_from_populations"], [18, 3, 1, "", "calculate"], [18, 3, 1, "", "calculate_add"], [18, 3, 1, "", "calculate_dataframe"], [18, 3, 1, "", "calculate_divide"], [18, 3, 1, "", "calculate_output"], [18, 3, 1, "", "clear_macro_cache"], [18, 3, 1, "", "clone"], [18, 3, 1, "", "create_shortcuts"], [18, 4, 1, "", "data_storage_dir"], [18, 2, 1, "", "dataset"], [18, 2, 1, "", "datasets"], [18, 2, 1, "", "debug"], [18, 2, 1, "", "default_calculation_period"], [18, 2, 1, "", "default_dataset"], [18, 2, 1, "", "default_input_period"], [18, 2, 1, "", "default_role"], [18, 2, 1, "", "default_tax_benefit_system"], [18, 2, 1, "", "default_tax_benefit_system_instance"], [18, 3, 1, "", "delete_arrays"], [18, 3, 1, "", "derivative"], [18, 3, 1, "", "describe_entities"], [18, 3, 1, "", "extract_person"], [18, 3, 1, "", "get_array"], [18, 3, 1, "", "get_branch"], [18, 3, 1, "", "get_entity"], [18, 3, 1, "", "get_holder"], [18, 3, 1, "", "get_known_periods"], [18, 3, 1, "", "get_memory_usage"], [18, 3, 1, "", "get_population"], [18, 3, 1, "", "get_variable_population"], [18, 3, 1, "", "get_weights"], [18, 3, 1, "", "invalidate_cache_entry"], [18, 3, 1, "", "invalidate_spiral_variables"], [18, 2, 1, "", "is_over_dataset"], [18, 3, 1, "", "link_to_entities_instances"], [18, 2, 1, "", "macro_cache_read"], [18, 2, 1, "", "macro_cache_write"], [18, 3, 1, "", "map_result"], [18, 2, 1, "", "max_spiral_loops"], [18, 2, 1, "", "memory_config"], [18, 2, 1, "", "opt_out_cache"], [18, 3, 1, "", "purge_cache_of_invalid_values"], [18, 3, 1, "", "sample_person"], [18, 3, 1, "", "set_input"], [18, 4, 1, "", "trace"], [18, 2, 1, "", "tracer"]], "policyengine_core.simulations.simulation": [[18, 1, 1, "", "Simulation"]], "policyengine_core.simulations.simulation.Simulation": [[18, 3, 1, "", "apply_reform"], [18, 2, 1, "", "baseline"], [18, 3, 1, "", "build_from_dataset"], [18, 3, 1, "", "build_from_populations"], [18, 3, 1, "", "calculate"], [18, 3, 1, "", "calculate_add"], [18, 3, 1, "", "calculate_dataframe"], [18, 3, 1, "", "calculate_divide"], [18, 3, 1, "", "calculate_output"], [18, 3, 1, "", "clear_macro_cache"], [18, 3, 1, "", "clone"], [18, 3, 1, "", "create_shortcuts"], [18, 4, 1, "", "data_storage_dir"], [18, 2, 1, "", "datasets"], [18, 2, 1, "", "default_calculation_period"], [18, 2, 1, "", "default_dataset"], [18, 2, 1, "", "default_input_period"], [18, 2, 1, "", "default_role"], [18, 2, 1, "", "default_tax_benefit_system"], [18, 2, 1, "", "default_tax_benefit_system_instance"], [18, 3, 1, "", "delete_arrays"], [18, 3, 1, "", "derivative"], [18, 3, 1, "", "describe_entities"], [18, 3, 1, "", "extract_person"], [18, 3, 1, "", "get_array"], [18, 3, 1, "", "get_branch"], [18, 3, 1, "", "get_entity"], [18, 3, 1, "", "get_holder"], [18, 3, 1, "", "get_known_periods"], [18, 3, 1, "", "get_memory_usage"], [18, 3, 1, "", "get_population"], [18, 3, 1, "", "get_variable_population"], [18, 3, 1, "", "invalidate_cache_entry"], [18, 3, 1, "", "invalidate_spiral_variables"], [18, 2, 1, "", "is_over_dataset"], [18, 3, 1, "", "link_to_entities_instances"], [18, 2, 1, "", "macro_cache_read"], [18, 2, 1, "", "macro_cache_write"], [18, 3, 1, "", "map_result"], [18, 3, 1, "", "purge_cache_of_invalid_values"], [18, 3, 1, "", "sample_person"], [18, 3, 1, "", "set_input"], [18, 4, 1, "", "trace"]], "policyengine_core.simulations.simulation_builder": [[18, 1, 1, "", "SimulationBuilder"]], "policyengine_core.simulations.simulation_builder.SimulationBuilder": [[18, 3, 1, "", "add_default_group_entity"], [18, 3, 1, "", "add_group_entity"], [18, 3, 1, "", "add_parallel_axis"], [18, 3, 1, "", "add_perpendicular_axis"], [18, 3, 1, "", "add_person_entity"], [18, 3, 1, "", "add_variable_value"], [18, 3, 1, "", "build"], [18, 3, 1, "", "build_default_simulation"], [18, 3, 1, "", "build_from_dict"], [18, 3, 1, "", "build_from_entities"], [18, 3, 1, "", "build_from_variables"], [18, 3, 1, "", "check_persons_to_allocate"], [18, 3, 1, "", "create_entities"], [18, 3, 1, "", "declare_entity"], [18, 3, 1, "", "declare_person_entity"], [18, 3, 1, "", "expand_axes"], [18, 3, 1, "", "explicit_singular_entities"], [18, 3, 1, "", "finalize_variables_init"], [18, 3, 1, "", "get_count"], [18, 3, 1, "", "get_ids"], [18, 3, 1, "", "get_input"], [18, 3, 1, "", "get_memberships"], [18, 3, 1, "", "get_roles"], [18, 3, 1, "", "get_variable_entity"], [18, 3, 1, "", "init_variable_values"], [18, 3, 1, "", "join_with_persons"], [18, 3, 1, "", "nb_persons"], [18, 3, 1, "", "raise_period_mismatch"], [18, 3, 1, "", "register_variable"], [18, 3, 1, "", "set_default_period"]], "policyengine_core.taxbenefitsystems.tax_benefit_system": [[19, 1, 1, "", "TaxBenefitSystem"]], "policyengine_core.taxbenefitsystems.tax_benefit_system.TaxBenefitSystem": [[19, 3, 1, "", "add_modelled_policy_metadata"], [19, 3, 1, "", "add_variable"], [19, 3, 1, "", "add_variable_metadata_from_folder"], [19, 3, 1, "", "add_variables"], [19, 3, 1, "", "add_variables_from_directory"], [19, 3, 1, "", "add_variables_from_file"], [19, 3, 1, "", "apply_reform"], [19, 2, 1, "", "auto_carry_over_input_variables"], [19, 2, 1, "", "basic_inputs"], [19, 2, 1, "", "entities"], [19, 3, 1, "", "get_package_metadata"], [19, 3, 1, "", "get_parameters_at_instant"], [19, 3, 1, "", "get_variable"], [19, 3, 1, "", "get_variables"], [19, 3, 1, "", "load_extension"], [19, 3, 1, "", "load_parameters"], [19, 2, 1, "", "modelled_policies"], [19, 3, 1, "", "modify_parameters"], [19, 3, 1, "", "neutralize_variable"], [19, 2, 1, "", "parameters"], [19, 2, 1, "", "parameters_dir"], [19, 3, 1, "", "replace_variable"], [19, 3, 1, "", "update_variable"], [19, 2, 1, "", "variables_dir"]], "policyengine_core.taxscales.abstract_rate_tax_scale": [[20, 1, 1, "", "AbstractRateTaxScale"]], "policyengine_core.taxscales.abstract_rate_tax_scale.AbstractRateTaxScale": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.abstract_tax_scale": [[20, 1, 1, "", "AbstractTaxScale"]], "policyengine_core.taxscales.amount_tax_scale_like": [[20, 1, 1, "", "AmountTaxScaleLike"]], "policyengine_core.taxscales.linear_average_rate_tax_scale": [[20, 1, 1, "", "LinearAverageRateTaxScale"]], "policyengine_core.taxscales.linear_average_rate_tax_scale.LinearAverageRateTaxScale": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.marginal_amount_tax_scale": [[20, 1, 1, "", "MarginalAmountTaxScale"]], "policyengine_core.taxscales.marginal_amount_tax_scale.MarginalAmountTaxScale": [[20, 3, 1, "", "calc"]], "policyengine_core.taxscales.marginal_rate_tax_scale": [[20, 1, 1, "", "MarginalRateTaxScale"]], "policyengine_core.taxscales.marginal_rate_tax_scale.MarginalRateTaxScale": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "calc"], [20, 3, 1, "", "inverse"], [20, 3, 1, "", "marginal_rates"], [20, 3, 1, "", "rate_from_bracket_indice"], [20, 3, 1, "", "rate_from_tax_base"], [20, 3, 1, "", "scale_tax_scales"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.rate_tax_scale_like": [[20, 1, 1, "", "RateTaxScaleLike"]], "policyengine_core.taxscales.rate_tax_scale_like.RateTaxScaleLike": [[20, 3, 1, "", "bracket_indices"], [20, 3, 1, "", "threshold_from_tax_base"]], "policyengine_core.taxscales.single_amount_tax_scale": [[20, 1, 1, "", "SingleAmountTaxScale"]], "policyengine_core.taxscales.single_amount_tax_scale.SingleAmountTaxScale": [[20, 3, 1, "", "calc"]], "policyengine_core.taxscales.tax_scale_like": [[20, 1, 1, "", "TaxScaleLike"]], "policyengine_core.tools.simulation_dumper": [[21, 0, 1, "", "dump_simulation"], [21, 0, 1, "", "restore_simulation"]], "policyengine_core.tools.test_runner": [[21, 0, 1, "", "run_tests"]], "policyengine_core.tracers.computation_log": [[22, 1, 1, "", "ComputationLog"]], "policyengine_core.tracers.computation_log.ComputationLog": [[22, 3, 1, "", "print_log"]], "policyengine_core.tracers.flat_trace": [[22, 1, 1, "", "FlatTrace"]], "policyengine_core.tracers.full_tracer": [[22, 1, 1, "", "FullTracer"]], "policyengine_core.tracers.performance_log": [[22, 1, 1, "", "PerformanceLog"]], "policyengine_core.tracers.simple_tracer": [[22, 1, 1, "", "SimpleTracer"]], "policyengine_core.tracers.trace_node": [[22, 1, 1, "", "TraceNode"]], "policyengine_core.tracers.tracing_parameter_node_at_instant": [[22, 1, 1, "", "TracingParameterNodeAtInstant"]], "policyengine_core.variables.variable": [[24, 1, 1, "", "Variable"]], "policyengine_core.variables.variable.Variable": [[24, 2, 1, "", "adds"], [24, 2, 1, "", "baseline_variable"], [24, 2, 1, "", "default_value"], [24, 2, 1, "", "defined_for"], [24, 2, 1, "", "definition_period"], [24, 2, 1, "", "documentation"], [24, 2, 1, "", "dtype"], [24, 2, 1, "", "end"], [24, 2, 1, "", "entity"], [24, 2, 1, "", "exhaustive_parameter_dependencies"], [24, 2, 1, "", "formulas"], [24, 3, 1, "", "get_formula"], [24, 3, 1, "", "get_introspection_data"], [24, 2, 1, "", "hidden_input"], [24, 2, 1, "", "index_in_module"], [24, 3, 1, "", "is_input_variable"], [24, 2, 1, "", "is_neutralized"], [24, 2, 1, "", "json_type"], [24, 2, 1, "", "label"], [24, 2, 1, "", "max_length"], [24, 2, 1, "", "metadata"], [24, 2, 1, "", "module_name"], [24, 2, 1, "", "name"], [24, 3, 1, "", "parse_formula_name"], [24, 2, 1, "", "possible_values"], [24, 2, 1, "", "quantity_type"], [24, 2, 1, "", "reference"], [24, 2, 1, "", "requires_computation_after"], [24, 2, 1, "", "set_input"], [24, 2, 1, "", "subtracts"], [24, 2, 1, "", "unit"], [24, 2, 1, "", "uprating"], [24, 2, 1, "", "value_type"]], "policyengine_core.warnings": [[25, 1, 1, "", "LibYAMLWarning"], [25, 1, 1, "", "MemoryConfigWarning"], [25, 1, 1, "", "TempfileWarning"]], "policyengine_core.warnings.LibYAMLWarning": [[25, 3, 1, "", "with_traceback"]], "policyengine_core.warnings.MemoryConfigWarning": [[25, 3, 1, "", "with_traceback"]], "policyengine_core.warnings.TempfileWarning": [[25, 3, 1, "", "with_traceback"]]}, "objtypes": {"0": "py:function", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:module"}, "objnames": {"0": ["py", "function", "Python function"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "module", "Python module"]}, "titleterms": {"how": 0, "contribut": 0, "changelog": 0, "entri": 0, "pull": 0, "request": 0, "introduct": 1, "common": 2, "formula": 2, "apply_threshold": 2, "concat": 2, "switch": 2, "countri": [3, 28], "templat": [3, 10], "countrytaxbenefitsystem": 3, "data": [4, 5, 27], "dataset": [4, 29], "publicdataset": 4, "privatedataset": 4, "storag": 5, "inmemorystorag": 5, "ondiskstorag": 5, "entiti": 6, "groupent": 6, "role": 6, "build_ent": 6, "enum": 7, "enumarrai": 7, "error": 8, "nancreationerror": 8, "parameternotfounderror": 8, "parameterparsingerror": 8, "periodmismatcherror": 8, "situationparsingerror": 8, "spiralerror": 8, "variablenameconflicterror": 8, "variablenotfounderror": 8, "experiment": 9, "featur": 9, "memoryconfig": 9, "extens": 10, "holder": 11, "set_input_dispatch_by_period": 11, "set_input_divide_by_period": 11, "paramet": [12, 30, 31], "parameternod": 12, "parameteratinst": 12, "parameternodeatinst": 12, "parameterscal": 12, "parameterscalebracket": 12, "atinstantlik": 12, "vectorialparameternodeatinst": 12, "contains_nan": 12, "load_parameter_fil": 12, "period": 13, "instant": 13, "popul": [14, 32], "grouppopul": 14, "projector": 15, "entitytopersonprojector": 15, "firstpersontoentityprojector": 15, "uniqueroletoentityprojector": 15, "reform": [16, 31], "script": 17, "simul": [18, 32], "microsimul": 18, "simulationbuild": 18, "tax": [19, 20], "benefit": 19, "system": 19, "taxbenefitsystem": 19, "scale": 20, "taxscalelik": 20, "ratetaxscalelik": 20, "abstracttaxscal": 20, "abstractratetaxscal": 20, "amounttaxscalelik": 20, "singleamounttaxscal": 20, "marginalratetaxscal": 20, "marginalamounttaxscal": 20, "linearaverageratetaxscal": 20, "tool": 21, "run_test": 21, "dump_simul": 21, "restore_simul": 21, "tracer": 22, "computationlog": 22, "flattrac": 22, "fulltrac": 22, "performancelog": 22, "simpletrac": 22, "tracenod": 22, "tracingparameternodeatinst": 22, "type": 23, "variabl": [24, 31], "warn": 25, "libyamlwarn": 25, "memoryconfigwarn": 25, "tempfilewarn": 25, "chart": 26, "bar": 26, "cross": 26, "section": 26, "us": 27, "command": 27, "line": 27, "interfac": [27, 28], "posit": 27, "argument": 27, "sub": 27, "test": 27, "name": 27, "creat": 28, "packag": 28, "build": 28, "repo": 28, "write": [29, 30, 31], "exampl": 29, "api": 29, "valu": 30, "metadata": 30, "node": 30, "specifi": 30, "refer": 30, "unit": 30, "other": 30, "specif": 30, "modifi": 31, "polici": 32, "individu": 32, "household": 32, "over": 32, "ax": 32}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1, "sphinx": 56}})
\ No newline at end of file
diff --git a/usage/parameters.html b/usage/parameters.html
index 240f8cbf2..a39c881ba 100644
--- a/usage/parameters.html
+++ b/usage/parameters.html
@@ -277,10 +277,11 @@ <h2>Parameter values<a class="headerlink" href="#parameter-values" title="Permal
 <h2>Metadata<a class="headerlink" href="#metadata" title="Permalink to this heading">#</a></h2>
 <p>Each parameter (or parameter node) can also set <strong>metadata</strong>: data that describes the parameter, such as its name, description, and units. While the metadata for each parameter and node is freeform, using the schemas defined in <code class="docutils literal notranslate"><span class="pre">policyengine_core.data_structures</span></code> will ensure consistency between country packages, and better maintainability.</p>
 <p>Here’s an example metadata specification for the <code class="docutils literal notranslate"><span class="pre">child_benefit.basic.amount</span></code> parameter:</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">metadata</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">child_benefit</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">The UK provides this Child Benefit per child.</span>
+
+<span class="nt">metadata</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">label</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Child Benefit</span>
-<span class="w">    </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">The amount of Child Benefit paid per child.</span>
+<span class="w">    </span><span class="nt">period</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">year</span>
 <span class="w">    </span><span class="nt">unit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">currency-GBP</span>
 <span class="w">    </span><span class="nt">reference</span><span class="p">:</span><span class="w"> </span>
 <span class="w">        </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">label</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GOV.UK | Child Benefit</span>