policyengine / policyengine-us Goto Github PK

The PolicyEngine US Python package contains a rules engine of the US tax-benefit system, and microdata generation for microsimulation analysis.

Home Page: https://policyengine.org/us

License: GNU Affero General Public License v3.0

Makefile 0.05% Python 99.73% Jupyter Notebook 0.22%

economics policy python tax united-states economic-policy poverty public-policy inequality

policyengine-us's Introduction

PolicyEngine US

PolicyEngine US is a microsimulation model of the US state and federal tax and benefit system.

To install, run pip install policyengine-us.

policyengine-us's People

Contributors

Stargazers

Watchers

Forkers

maxghenis nmrodelo nikhilwoodruff tax-benefit tolaouk parikhsachi yvvijay121 jason017 kvanalebeek mallick-prat fedderw intheaggregate jdebacker andersonfrailey matthjensen wesleysmith1 mwufi josh-marsh aleida24 pavelmakarchuk alex-rand manasip5 kevinxperese ss7886 rickecon kfoster19 gsadowsky dtlawhon ivonne-hernandez calebpena leogoldman dantemorazan austinperryfrancis patneyland rykerjlow mitchellpound shermanmarshall codefordallas brianklemm-git kathrynpanger cmfung k-obenschain ziqiancui shaylawoo flameo3o chiukai-c ruoqitan jnaux xudonglai0426 sqw0418 yingjiejyj zwayen oliverh233 kim1277 xiaodan99 dnnnnn0626 weihaoz724 robgorman senoel123 jacky5124 leonali030 oliviacaiww snownow0w mzx-4real linfeng-ll judyz13 jonladalla zhiqinginwashu yaohhhh pxu12 hua7450 lodestone46 genejung xhu493 weishan-lu dianashi5083 yy3187 haolinxx ruarua7788 laomaitou alexandermies rikesh-patel michaelgyxu westurner mshuning eleanor-zhu chelsea128 violetchen0916 kehanbi yedeer12 kevintowne carolinecc123 xinyi-shao suriluo kiki-67 patricia-1998 jaewoongy keepjojoyoung leqigogo itsmexw

policyengine-us's Issues

CPS Microdata Input

Add "personal_income" as a layer to parameters/tax/

This might be premature and introduce a lot of extra typing, but in case we want other tax types down the road (corporate, employer, consumption, carbon, etc.), we may want to add a layer after parameters/tax, e.g. parameters/tax/personal_income or parameters/tax/pit (a common abbreviation referring to Personal Income Tax), or parameters/pit.

Add tax output variables

We need to add the following output variables from tax-calculator:

make a test for max snap benefit, add to existing tests

Add inputs for tax variables

On the microdata side, we're going to need survey inputs for the different tax variables used as input to tax logic. This will involve essentially trying to replicate taxdata's process for the CPS. taxdata uses the same input dataset as us (the CPS), so to do this, we'll need to do the following for every variable in the output dataset:

Look at the source code and understand the process of creating it from CPS variables
For every CPS variable used, add an OpenFisca variable to openfisca-data in survey_input_variables.py like this.
Add a variable to model_input_variables.py like this.

This should be fairly procedural, but since taxdata iterates over rows rather than using Pandas (we're using Pandas), there might be instances where iterative approaches might be hard to replicate using vectorised functions: I'd advise to just skip those variables for now, and come back later to think about them.

Validate against UsTaxes

https://github.com/ustaxes/UsTaxes

Add wiki page with instructions on translating variable from taxcalc

Add tax input variables

We need to add the following input variables from tax-calculator:

Policy parameter for % of net income SNAP eligibility threshold

Mirroring #6

Currently 100%

Impute SNAP to meet administrative totals

See https://colab.research.google.com/drive/1_BP3nFBqZ3ZFrkf4z4JxAm99IJJ6aB4J

Implement SNAP rules at the national level

This guide has overall national features of the program, which we can apply without getting into state-level details
https://www.cbpp.org/research/food-assistance/a-quick-guide-to-snap-eligibility-and-benefits

Add black code formatting precommit

Implement `calcfunctions` from Tax-Calculator

Implementing the logic and parameters from calcfunctions.py in tax-calculator. Each function needs to:

Have input and output parameters and variables present in openfisca-us
Be decomposed into a set of many-in, one-out functions, preserving the logic (tax-calculator functions can be many-in, many-out), by adding intermediate variables as OpenFisca variables
Have iterative logic re-implemented in vectorised form in each formula
Have any unit tests from test_calcfunctions.py re-implemented in openfisca-us

Add simple reform example to docs

Currently the two examples in https://ubicenter.github.io/openfisca-us/#reforms are:

From a large yaml file
Within a loop

Let's start with a very simple one, like changing the payroll tax rate.

Add AGI logic

Add parameters and logic from the AGI function in tax-calculator.

Translate tax formulas

Translating tax formulas from tax-calculator will require converting compiled functions to vectorized functions and multi-output functions to single-output functions, using parameters where necessary.

Model state-by-state SNAP rules

SNAP:
https://www.ers.usda.gov/data-products/snap-policy-data-sets/

Add Adj

Add the tax policy logic from the Adj function in tax-calculator, including parameters, intermediate and output variables.

Document parameter organization and naming conventions

See for example #41 (comment)

For example, one specific question: Should parameters include the attribute by which it's segmented? e.g. the standard deduction amount is currently named filer as that's what it's specified by. If not (e.g. if we called it amount) is there another way to hint the breakdown? We would ideally hint both the quantity type (e.g. amount vs thresholds) and the breakdown.

It'd probably be good to spec out the tree we're planning to fill in at the first ~3 levels of depth.

Add tax parameters

All parameters from tax-calculator will need to be added as parameters.

The full list is:

Document the data extraction routine

User Story:
As a developer, I want to know the input, output and logic of converting raw data into taxdata.

AC:

steps to set up local development
definitions and links for input, output sample data
notes for parsing logic

Policy parameters for SNAP deductions

Implement policy parameter for SNAP maximum amount

https://www.cbpp.org/research/food-assistance/a-quick-guide-to-snap-eligibility-and-benefits

Implement Section 8 Project-Based Rental Assistance

I think this is a subset of housing assistance as reported in the ASEC

https://www.cbpp.org/research/housing/section-8-project-based-rental-assistance

Add updated SNAP benefits for FY2022

https://apnews.com/article/health-coronavirus-pandemic-9832ab299bd1a5953f305ec1ae2b8ea9

Calculate SNAP benefit output variable at SPM unit level

Last step of all other SNAP issues

Add CPS module to `openfisca-data`

We'll use the existing infrastructure in openfisca-data (along with potentially a rename) to maintain the standardised dataset generation procedure. This will involve:

Creating a new @dataset-decorated class for BaseCPS
Adding the survey variables as OpenFisca variables
Adding the model input variables
Adding a new dataset class with the survey variables skipped - CPS

This structure follows almost exactly the process for FRS and SPI in the UK model.

Consider autopep8 in addition to black

Autopep8 does some comment formatting that black doesn't do, such as splitting long comment lines and ensuring a space follows the #. Should we run it prior to black?

Policy Parameter to take into account elderly or disabled individual status in SNAP receiving households

There are significant differences between calculating benefits for households with and without at least one elderly and/or disabled person. For example, for most states the standard shelter deduction is capped at 569 per month, unless the household has an elderly or disabled individual living in it, in which case there is no cap.

Additionally, on the income eligibility page, there is a separate table for such households, with more generous income limits:
https://fns-prod.azureedge.net/sites/default/files/media/file/FY21-Income-Eligibility-Standards.pdf

Per the USDA, in 2018 roughly 23% of SNAP receiving households met this criteria, meaning it is not a fringe population.

https://www.fns.usda.gov/snap/characteristics-households-fy-2018#:~:text=Seven%20percent%20of%20all%20participants,households%20had%20earnings%20in%20FY2018.

Benefit unit level net income input variable

Might be an intermediate variable, used for SNAP

Document variable translation from taxdata to cps_us data

Story:
As a developer, to make the raw cps us variables ready to use for modeling, I need to

understand how the variables are translated from survey to model
a way to test if my translation is correct

Acceptance Criteria:

Document the following information in openfisca-data repo in markdown
(1) Variables name mapping (raw name, family/household/person, mapped output name)
(2) Logic for each variable translation (just renaming or steps to process)
(3) Prioritization groups:
a. [important+easy]: Variables that are ready to translate with clear processing steps
b. [important+hard]: Variables that are important in the future but needs more efforts to clarify the processing steps
c. [not important]: Variables that are not important at the moment because it is not used in taxdata.
(4) Any reference and unanswered questions
Create Google Doc to organize links of all docs and share it with us developer group

Impute homelessness status

Obviously a wish list item, but I stumbled across separate policy parameters in snap for homeless individuals, and I explored around and found this very new journal article:
https://cpb-us-w2.wpmucdn.com/voices.uchicago.edu/dist/d/1370/files/2017/05/Homelessness-Full-Paper-May-24-2021.pdf

Very unexplored area, maybe for a rainy day?

Benefit unit level number of persons

This goes into SNAP but is probably unnecessary as it can come from summing persons, is that right @nikhilwoodruff ?

Add administrative totals for benefit programs

We can then use these to augment the data via synthimpute. @nikhilwoodruff would these belong in the standard benefit path, or somewhere else since they're not policy parameters?

If the standard path, it could be something like:

parameters/benefit/{benefit}/admin/{totals,overhead}.yaml

(totals could have subcomponents for spending and participation)

Implement policy parameter for % of poverty line below which gross monthly income must be for SNAP

Currently 1.3 (130%) per https://www.cbpp.org/research/food-assistance/a-quick-guide-to-snap-eligibility-and-benefits

Gross monthly income — that is, household income before any of the program’s deductions are applied — generally must be at or below 130 percent of the poverty line. For a family of three, the poverty line used to calculate SNAP benefits in federal fiscal year 2021 is $1,810 a month. Thus, 130 percent of the poverty line for a three-person family is $2,353 a month, or about $28,200 a year. The poverty level is higher for bigger families and lower for smaller families

SPM unit level SNAP gross income

Mirroring #14

Add SNAP integration tests from CBPP

Add DependentCare

We should add the parameters, intermediate and output variables for the DependentCare function in tax-calculator

Basic prototype

@MaxGhenis

For a basic proof-of-concept, with the standard deduction and rates, we could ideally have:

Standard deduction, rates added to parameters
Variables for the inputs and after-tax income variable
Microdata loading function (CPS/PUF)
~~At least 5 tests (tax-calculator tests)~~
A Jupyter Book with some explanation and a demo (some Plotly graph output)

Document standard metadata for parameters

e.g. unit, reference

Add to wiki

Policy parameter for SNAP phase-out rate

Add documentation on how to test

After running pip install -e . from root and pytest I get this error:

(base) mghenis@penguin:~/UBICenter/openfisca-us$ pytest
=== test session starts ===
platform linux -- Python 3.7.7, pytest-5.4.3, py-1.10.0, pluggy-0.13.1
rootdir: /home/mghenis/UBICenter/openfisca-us, inifile: setup.cfg, testpaths: openfisca_country_template/tests
plugins: anyio-3.0.1, dash-1.20.0
collected 0 items

=== no tests ran in 0.02s ===
ERROR: file not found: openfisca_country_template/tests

What am I missing? Let's add the installation and testing procedure to the docs.

Add wiki page with instructions on translating parameter from taxcalc

Create CPS input file

We need to effectively reproduce the taxdata method of creating tax units with all required variables, and at the same time also create person, family, household, and later SPM unit entities. This will involve adding a few modules to openfisca-data.

test issue moon

Hi there!

I really enjoy OpenFisca, but I recently encountered an issue.

Here is what I did:

Here is what I expected to happen:

Here is what actually happened:

Here is data (or links to it) that can help you reproduce this issue:

Context

I identify more as a:

Analyst (I make macroscopic computations on real populations).
Business expert (I create tests and model legislation).
Commenter (I make data visualisations).
Developer (I create tools that use the existing OpenFisca code).
Historian (I accumulate data based on past legislation values).
Lobbyist (I model reforms to make them exist).
Producer (I make computations on individual situations).

(remove this line as well as all items in the list that don't fit your situation)

Make an indexing enum for inflation adjustments & include with USD params

Currently it could be either None (or False?) or CPI.

In taxcalc, this is identified via indexed, e.g.:

https://github.com/PSLmodels/Tax-Calculator/blob/2ccfcb446d281aa8f733be59f591de931a41ad24/taxcalc/policy_current_law.json#L153