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.38.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.38-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: policyengine_uk-2.88.38.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.38.tar.gz
Algorithm Hash digest
SHA256 f4da777f6b6a48c85600e93379973053138d78eebe1e34435a6dee14fd40331a
MD5 a0d4ec1ab5750209cb74acbd97bbdde3
BLAKE2b-256 0ac58ce28c9e180728f11beb7f0e7db670e4916b2f563503dfcf13a71ea853df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for policyengine_uk-2.88.38-py3-none-any.whl
Algorithm Hash digest
SHA256 e14a44c5d3625fd2e6da14b41d4e8c9a417c6c4dcc9a7a5a1b8b3b975436ce51
MD5 fe4a48a715b871652d4ae2ab1d65b09b
BLAKE2b-256 231a9f55d9354106de118b4b6be0c9d474d5ba826d96943c4cf70daddf4eea3e

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