PolicyEngine UK

PyPI version Code style: black

For microsimulation, use policyengine.py. Society-wide microsimulation — population aggregates and distributional or budgetary impacts — is moving to the managed policyengine.py bundle, which pins certified, calibration-gated datasets. Direct microsimulation via policyengine-uk (Microsimulation()) is deprecated and being migrated to policyengine.py. This package remains the home of the UK tax-benefit rules and household-level calculations. Microsimulation results are estimates.

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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.90.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for policyengine from gravatar.com policyengine

Credits

Author: PolicyEngine

Maintainer: Nikhil Woodruff

License expression

AGPL-3.0
View SPDX License List

Requires

Python >=3.9

Provides Extra

dev

Tags

benefit microsimulation social tax

Classifiers

Report project as malware

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for policyengine_uk-2.89.3.tar.gz
Algorithm Hash digest
SHA256 b9d42233b8d5cdee4407f213cdaff9bf25157da18767cd38ea0654f313f841cf
MD5 2286a0117b36b43a1c6e9827c363566e
BLAKE2b-256 905bfb0d4785c3fbe180a14dc05bd55e2d4aafd217c802601d6c83658e87e4d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for policyengine_uk-2.89.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8c77ce62e3f643c497b9e26a576bb5a43f069e71ed7cf44a0bbee88a42245482
MD5 c60665ac08a2c0baa45d16fb4bc55392
BLAKE2b-256 aebb1360e65f04d75976e599829cc05eab37725c17877da3ef544306ddee8d9e

See more details on using hashes here.

Release history Release notifications | RSS feed

2.90.0

2.89.4

This release

2.89.3

2.89.2

2.89.1

2.89.0

2.88.65

2.88.64

2.88.63

2.88.62

2.88.61

2.88.60

2.88.59

2.88.58

2.88.57

2.88.56

2.88.55

2.88.54

2.88.53

2.88.52

2.88.51

2.88.50

2.88.49

2.88.48

2.88.47

2.88.46

2.88.45

2.88.44

2.88.43

2.88.42

2.88.41

2.88.40

2.88.39

2.88.38

2.88.37

2.88.36

2.88.35

2.88.34

2.88.33

2.88.32

2.88.31

2.88.30

2.88.29

2.88.28

2.88.27

2.88.26

2.88.25

2.88.24

2.88.23

2.88.22

2.88.21

2.88.20

2.88.19

2.88.18

2.88.17

2.88.16

2.88.15

2.88.14

2.88.13

2.88.12

2.88.11

2.88.10

2.88.9

2.88.8

2.88.7

2.88.6

2.88.5

2.88.4

2.88.3

2.88.2

2.88.1

2.88.0

2.87.1

2.87.0

2.86.13

2.86.12

2.86.11

2.86.10

2.86.9

2.86.8

2.86.7

2.86.6

2.86.5

2.86.4

2.86.3

2.86.2

2.86.1

2.86.0

2.85.0

2.84.0

2.83.0

2.82.0

2.81.0

2.80.0

2.79.3

2.79.2

2.79.1

2.79.0

2.78.0

2.77.5

2.77.4

2.77.3

2.77.2

2.77.1

2.77.0

2.76.0

2.75.4

2.75.3

2.75.2

2.75.1

2.75.0

2.74.0

2.73.2

2.73.1

2.73.0

2.72.4

2.72.3

2.72.2

2.72.1

2.72.0

2.71.1

2.71.0

2.70.7

2.70.6

2.70.5

2.70.4

2.70.3

2.70.2

2.70.1

2.70.0

2.69.0

2.68.1

2.68.0

2.67.0

2.66.0

2.65.9

2.65.8

2.65.7

2.65.6

2.65.5

2.65.4

2.65.3

2.65.2

2.65.1

2.65.0

2.64.1

2.64.0

2.63.0

2.62.1

2.62.0

2.61.4

2.61.3

2.61.2

2.61.1

2.61.0

2.60.0

2.59.0

2.58.0

2.57.1

2.57.0

2.56.1

2.56.0

2.55.3

2.55.2

2.55.1

2.55.0

2.54.2

2.54.1

2.53.1

2.53.0

2.52.1

2.52.0

2.51.0

2.50.0

2.49.5

2.49.4

2.49.3

2.49.2

2.49.1

2.49.0

2.48.0

2.47.4

2.47.3

2.47.2

2.45.4

2.45.3

2.45.2

2.45.1

2.45.0

2.44.1

2.44.0

2.43.5

2.43.4

2.43.3

2.43.2

2.43.1

2.43.0

2.42.0

2.41.4

2.41.3

2.41.2

2.41.1

2.41.0

2.40.2

2.40.1

2.40.0

2.39.3

2.39.1

2.39.0

2.38.2

2.38.1

2.38.0

2.37.0

2.36.1

2.36.0

2.35.1

2.35.0

2.34.5

2.34.4

2.34.3

2.34.2

2.34.1

2.34.0

2.33.0

2.32.4

2.32.3

2.32.2

2.32.1

2.32.0

2.31.0

2.30.0

2.29.0

2.28.3

2.28.2

2.28.1

2.28.0

2.27.0

2.26.1

2.26.0

2.25.0

2.24.2

2.24.1

2.24.0

2.23.2

2.23.1

2.23.0

2.22.8

2.22.7

2.22.6

2.22.5

2.22.4

2.22.3

2.22.2

2.22.1

2.22.0

2.21.0

2.20.0

2.19.4

2.19.3

2.19.2

2.19.1

2.19.0

2.18.0

2.17.0

2.16.0

2.15.1

2.15.0

2.14.1

2.14.0

2.13.2

2.13.1

2.13.0

2.12.0

2.11.0

2.10.0

2.9.0

2.8.0

2.7.0

2.6.0

2.5.0

2.4.0

2.3.0

2.2.0

2.1.1

2.1.0

2.0.0

1.8.0

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.0

1.5.1

1.4.0

1.3.0

1.2.0

1.1.0

1.0.0

0.86.6

0.86.5

0.86.4

0.86.3

0.86.2

0.86.1

0.86.0

0.85.0

0.84.0

0.83.2

0.83.1

0.83.0

0.82.0

0.81.0

0.80.0

0.79.0

0.78.0

0.77.0

0.76.0

0.75.0

0.74.1

0.74.0

0.73.1

0.73.0

0.72.0

0.71.0

0.70.0

0.69.1

0.69.0

0.68.0

0.67.0

0.66.0

0.65.0

0.64.0

0.63.2

0.63.1

0.63.0

0.62.2

0.62.1

0.62.0

0.61.3

0.61.2

0.61.1

0.61.0

0.60.0

0.59.0

0.58.2

0.58.1

0.58.0

0.57.0

0.56.4

0.56.3

0.56.2

0.56.1

0.56.0

0.55.4

0.55.3

0.55.2

0.55.1

0.55.0

0.54.0

0.53.0

0.52.0

0.51.1

0.51.0

0.50.1

0.50.0

0.49.1

0.49.0

0.48.0

0.47.0

0.46.0

0.45.1

0.45.0

0.44.3

0.44.2

0.44.1

0.44.0

0.43.0

0.42.1

0.42.0

0.41.11

0.41.10

0.41.9

0.41.8

0.41.7

0.41.6

0.41.5

0.41.4

0.41.3

0.41.2

0.41.1

0.41.0

0.40.0

0.39.0

0.38.6

0.38.5

0.38.4

0.38.3

0.38.2

0.38.1

0.38.0

0.37.6

0.37.5

0.37.4

0.37.3

0.37.2

0.37.1

0.37.0

0.36.2

0.36.1

0.36.0

0.35.0

Supported by

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