PolicyEngine UK
For microsimulation, use policyengine.py. Society-wide microsimulation — population aggregates and distributional or budgetary impacts — is moving to the managed
policyengine.pybundle, which pins certified, calibration-gated datasets. Direct microsimulation viapolicyengine-uk(Microsimulation()) is deprecated and being migrated topolicyengine.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
parametersfolder. - The formulas and inputs are in the
variablesfolder. - This country package comes also with reforms in the
reformsfolder.
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)
-
Run
pip install policyengine-uk -
Run
policyengine-ukand 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."
-
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 ↩
1 maintainer
Metadata
1 maintainer
Release files for policyengine-uk 2.125.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| policyengine_uk-2.125.1.tar.gz | 2.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| policyengine_uk-2.125.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 5.4 MB
Release files / policyengine_uk-2.125.1.tar.gz
| Download URL | policyengine_uk-2.125.1.tar.gz |
|---|---|
| Size | 2.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
96e0354c3e8d19cd9d4e7dc5ba6c3611f1305a589b63c5f065441df346c33ed5
|
|
BLAKE2b-256 checksum How to use checksums |
643bc7b4eaa2b80df7e520d0576399cf1c2cec6e29bdf4ecb0104496cfa0b946
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / policyengine_uk-2.125.1-py3-none-any.whl
| Download URL | policyengine_uk-2.125.1-py3-none-any.whl |
|---|---|
| Size | 3.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a0983b4cef868467578a4fd0d163a977a0da8f710dd5194ec01c75f66d512c5a
|
|
BLAKE2b-256 checksum How to use checksums |
ec3a1d90bad4346d1a8c2715be211ed3d3d7f48917da0d90405b8257b7304091
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
