https://github.com/PolicyEngine/policyengine-uk

The UK's only open-source static tax-benefit microsimulation model.
https://github.com/PolicyEngine/policyengine-uk

economic-policy economics inequality policy poverty psl-cataloged public-policy python tax united-kingdom

Last synced: 2 months ago
JSON representation

The UK's only open-source static tax-benefit microsimulation model.

• Host: GitHub
• URL: https://github.com/PolicyEngine/policyengine-uk
• Owner: PolicyEngine
• License: agpl-3.0
• Created: 2020-08-05T11:05:57.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T17:46:22.000Z (7 months ago)
• Last Synced: 2024-04-14T09:04:46.947Z (7 months ago)
• Topics: economic-policy, economics, inequality, policy, poverty, psl-cataloged, public-policy, python, tax, united-kingdom
• Language: Python
• Homepage: https://policyengine.github.io/policyengine-uk/
• Size: 352 MB
• Stars: 21
• Watchers: 5
• Forks: 21
• Open Issues: 256
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PolicyEngine UK

[![PyPI version](https://badge.fury.io/py/policyengine-uk.svg)](https://badge.fury.io/py/policyengine-uk)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

PolicyEngine UK is [PolicyEngine](https://policyengine.org)'s microsimulation model of the UK tax-benefit system.

It uses the PolicyEngine Core microsimulation framework, which is based on [OpenFisca](https://openfisca.org).

The elements are described in different folders. All the modelling happens within the `policyengine_uk` folder.

- The rates and other system parameters are in the `parameters` folder.

- The formulas and inputs are in the `variables` folder.

- This country package comes also with reforms in the `reforms` folder.

The files that are outside from the `policyengine_uk` folder are used to set up the development environment. Installation instructions are located along with other documentation in the `docs` folder.

The model supports multiple different input datasets provided by the user, one of which is the Family Resources Survey,[^1] containing microdata on household incomes across the UK.

PolicyEngine UK enhances this dataset by fusing it to other surveys and reweighting it to minimize a comprehensive loss metric that measures the difference from an array of administrative totals.

[^1]: Department for Work and Pensions, Office for National Statistics, NatCen Social Research. (2021). Family Resources Survey, 2019-2020. [data collection]. UK Data Service. SN: 8802, http://doi.org/10.5255/UKDA-SN-8802-1

## Fast setup instructions

1. Run `pip install policyengine-uk`

2. Run `policyengine-uk` and go through the prompt to setup microdata.

## Contact

The primary maintainer for PolicyEngine UK is Nikhil Woodruff, co-founder and CTO of PolicyEngine ([email protected]).

## Citation

You may cite the source of your analysis as "PolicyEngine UK release #.#.#, author's calculations."