{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "introduction",
   "metadata": {},
   "source": [
    "# Validate an export\n",
    "\n",
    "Validation returns every metadata issue it can safely identify in one report. This notebook downloads a small synthetic export so you can run it immediately. To validate your own data, change `PROJECT_FILE` to the path of your NeuroQP ZIP."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "validate-sample",
   "metadata": {},
   "outputs": [],
   "source": [
    "from pathlib import Path\n",
    "from urllib.request import urlretrieve\n",
    "\n",
    "from neuroqp import validate_export\n",
    "\n",
    "PROJECT_FILE = Path(\"neuroqp-example-v2.zip\")  # Change this to your own project export.\n",
    "EXAMPLE_URL = (\n",
    "    \"https://raw.githubusercontent.com/neuroqp/neuroqp-python/\"\n",
    "    \"bc913cd/docs/assets/downloads/neuroqp-example-v2.zip\"\n",
    ")\n",
    "if not PROJECT_FILE.is_file():\n",
    "    urlretrieve(EXAMPLE_URL, PROJECT_FILE)\n",
    "\n",
    "report = validate_export(PROJECT_FILE)\n",
    "report"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "assert-valid",
   "metadata": {},
   "outputs": [],
   "source": [
    "assert report.valid\n",
    "assert report.issues == ()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "name": "python",
   "version": "3.14"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}