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

Uploaded Python 3

File details

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

File metadata

  • Download URL: policyengine_uk-2.89.0.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.89.0.tar.gz
Algorithm Hash digest
SHA256 aea49956a350ec35c1e0def7cd28db324b055711ec5ab7f331395dca8d103341
MD5 44ea1ea87c91bbff7a33ab2f4c487f16
BLAKE2b-256 e44975c80cd9b1145d8cfd5efbdb534aca2c9d5c5722fef3fc8f4887831505ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for policyengine_uk-2.89.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72acae45a35a59cf7429bba69363601e624bfd643d50cd74b8d20d325497e9fd
MD5 496329b690cfc5ea52ac46ad9ffc6613
BLAKE2b-256 bb5ffd32a3f7314b02b3b6a8362d6b2869af5b51569301945c00ee1172e01914

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