Skip to main content

PolicyEngine tax and benefit system for the UK.

Project description

PolicyEngine UK

PyPI version Code style: black

PolicyEngine UK is PolicyEngine's microsimulation model of the UK tax-benefit system. It uses the PolicyEngine Core microsimulation framework, which is based on OpenFisca.

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.

Fast setup instructions (Linux / macOS)

  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 (nikhil@policyengine.org).

Citation

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

  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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

policyengine_uk-2.88.24.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

policyengine_uk-2.88.24-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file policyengine_uk-2.88.24.tar.gz.

File metadata

  • Download URL: policyengine_uk-2.88.24.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for policyengine_uk-2.88.24.tar.gz
Algorithm Hash digest
SHA256 fe69313855d910decb915349a7fa8a105f2b5bee424f96ff9d6f1a11a32b860a
MD5 9dcad81341177a644b7c79e1c2dbe37d
BLAKE2b-256 e2eaf697b622b012dfa7026ab2b1bb0391e16c2c055a4f7e394eec7a68f9bc9d

See more details on using hashes here.

File details

Details for the file policyengine_uk-2.88.24-py3-none-any.whl.

File metadata

File hashes

Hashes for policyengine_uk-2.88.24-py3-none-any.whl
Algorithm Hash digest
SHA256 82ea81b0ac2f53f2bc27181cb74fff0ef4d2ec156c1c5727a75d099a53c6a066
MD5 398636b01ba56042c61fb5f66b1ae103
BLAKE2b-256 41611138701b069bcc09411c3904d3019a9da098a2d3eb58c020e70f8f1bc2ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page