| extra_gated_heading: "Request access to PolicyEngine UK data" | |
| extra_gated_prompt: "This repository contains datasets derived from UK Data Service (UKDS) sources, including the Family Resources Survey. UKDS licence terms permit PolicyEngine to share these files only with users who themselves hold access to the source surveys on the UK Data Service. Requests are reviewed manually: email contact@policyengine.org with proof of your UKDS FRS access (for example, a screenshot of your UKDS project download page)." | |
| extra_gated_button_content: "Request access" | |
| # PolicyEngine UK Data | |
| Datasets powering [PolicyEngine UK](https://policyengine.org/uk) microsimulation, including enhanced Family Resources Survey files. | |
| File contents are gated. Access is granted only to users with a UK Data Service licence covering the source surveys — request access above and email proof of UKDS FRS access to contact@policyengine.org. | |
| Once granted, download with a Hugging Face token (classic "Read" token, or a fine-grained token with gated-repository permissions): | |
| ```python | |
| from huggingface_hub import hf_hub_download | |
| path = hf_hub_download( | |
| repo_id="policyengine/policyengine-uk-data-private", | |
| filename="enhanced_frs_2023_24.h5", | |
| repo_type="model", | |
| token="hf_...", | |
| ) | |
| ``` | |