policyengine-uk 2.42.0__py3-none-any.whl → 2.43.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- policyengine_uk/data/dataset_schema.py +63 -15
- policyengine_uk/data/economic_assumptions.py +18 -1
- policyengine_uk/model_api.py +1 -0
- policyengine_uk/parameters/gov/economic_assumptions/yoy_growth.yaml +1 -3
- policyengine_uk/scenarios/__init__.py +3 -0
- policyengine_uk/scenarios/pip_reform.py +23 -0
- policyengine_uk/scenarios/reindex_benefit_cap.py +32 -0
- policyengine_uk/scenarios/repeal_two_child_limit.py +10 -0
- policyengine_uk/system.py +543 -186
- policyengine_uk/tests/microsimulation/reforms_config.yaml +1 -1
- policyengine_uk/utils/scenario.py +184 -0
- policyengine_uk/variables/gov/dwp/winter_fuel_allowance.py +5 -4
- {policyengine_uk-2.42.0.dist-info → policyengine_uk-2.43.1.dist-info}/METADATA +11 -5
- {policyengine_uk-2.42.0.dist-info → policyengine_uk-2.43.1.dist-info}/RECORD +16 -16
- policyengine_uk/repo.py +0 -3
- policyengine_uk/tests/policy/baseline/gov/abolitions/abolition_parameters.yaml +0 -250
- policyengine_uk-2.42.0.data/data/share/openfisca/openfisca-country-template/CHANGELOG.md +0 -2334
- policyengine_uk-2.42.0.data/data/share/openfisca/openfisca-country-template/README.md +0 -37
- policyengine_uk-2.42.0.dist-info/licenses/LICENSE +0 -661
- {policyengine_uk-2.42.0.dist-info → policyengine_uk-2.43.1.dist-info}/WHEEL +0 -0
- {policyengine_uk-2.42.0.data/data/share/openfisca/openfisca-country-template → policyengine_uk-2.43.1.dist-info/licenses}/LICENSE +0 -0
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# PolicyEngine UK
|
|
2
|
-
|
|
3
|
-
[](https://badge.fury.io/py/policyengine-uk)
|
|
4
|
-
[](https://github.com/psf/black)
|
|
5
|
-
|
|
6
|
-
PolicyEngine UK is [PolicyEngine](https://policyengine.org)'s microsimulation model of the UK tax-benefit system.
|
|
7
|
-
It uses the PolicyEngine Core microsimulation framework, which is based on [OpenFisca](https://openfisca.org).
|
|
8
|
-
|
|
9
|
-
The elements are described in different folders. All the modelling happens within the `policyengine_uk` folder.
|
|
10
|
-
|
|
11
|
-
- The rates and other system parameters are in the `parameters` folder.
|
|
12
|
-
- The formulas and inputs are in the `variables` folder.
|
|
13
|
-
- This country package comes also with reforms in the `reforms` folder.
|
|
14
|
-
|
|
15
|
-
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.
|
|
16
|
-
|
|
17
|
-
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.
|
|
18
|
-
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.
|
|
19
|
-
|
|
20
|
-
[^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
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
## Fast setup instructions
|
|
24
|
-
|
|
25
|
-
1. Run `pip install policyengine-uk`
|
|
26
|
-
|
|
27
|
-
2. Run `policyengine-uk` and go through the prompt to setup microdata.
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## Contact
|
|
31
|
-
|
|
32
|
-
The primary maintainer for PolicyEngine UK is Nikhil Woodruff, co-founder and CTO of PolicyEngine (nikhil@policyengine.org).
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
## Citation
|
|
36
|
-
|
|
37
|
-
You may cite the source of your analysis as "PolicyEngine UK release #.#.#, author's calculations."
|