-
Notifications
You must be signed in to change notification settings - Fork 27
Structure
Nikhil Woodruff edited this page Nov 25, 2020
·
2 revisions
The model repository contains three main types of code:
- Formulas for person and group-level variables
- e.g. the
child_benefit
variable, defined as a function ofperson
,parameters
, andperiod
.
- e.g. the
- Simulation tools
- e.g. functions to generate entity-level DataFrames, or MTRs for persons.
- Parameters of implemented taxes and benefits
- e.g. the amount of Child Benefit payable to the first child per week, from 2016 to 2020.
Formulas are organised in the following structure:
- (applicable entity - person/benunit/household)
-
benefits
-
benefit_x.py
- one file per major benefit, e.g.housing_benefit
-
-
taxes
-
tax_x.py
- one file per major tax, e.g.income_tax
-
-
income.py
- variables which hold reported or calculated non-benefit income sources, e.g.rental_income
-
expense.py
- variables which hold reported or calculated expenses, e.g.childcare
-
attributes.py
- non-financial variables of the entity, e.g.is_male
forperson
oris_couple
forbenunit
-