Merge pull request #131 from PolicyEngine/data-docs

Improve documentation

Author: nikhilwoodruff

changelog_entry.yaml

@@ -0,0 +1,4 @@
+- bump: patch
+  changes:
+    fixed:
+    - Documentation used 2022 datasets rather than 2025.

docs/methodology.ipynb

@@ -9,7 +9,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -177,7 +177,7 @@
     "def get_validation():\n",
     "    df = pd.DataFrame()\n",
     "    for dataset in [FRS_2022_23, EnhancedFRS_2022_23]:\n",
-    "        for year in range(2022, 2029):\n",
+    "        for year in range(2025, 2029):\n",
     "            loss_results = get_loss_results(dataset, year)\n",
     "            loss_results[\"time_period\"] = year\n",
     "            loss_results[\"dataset\"] = dataset.label\n",

docs/validation/national.ipynb

@@ -0,0 +1,21 @@
+from policyengine_uk_data.utils.huggingface import download, upload
+from pathlib import Path
+
+
+FOLDER = Path(__file__).parent
+
+FILES = [
+    "enhanced_frs_2022_23.h5",
+    "frs_2022_23.h5",
+    "parliamentary_constituency_weights.h5",
+    "local_authority_weights.h5",
+]
+
+FILES = [FOLDER / file for file in FILES]
+
+for file in FILES:
+    download(
+        repo="policyengine/policyengine-uk-data",
+        repo_filename=file.name,
+        local_folder=file.parent,
+    )