docs: document widget-tutorials layout; retarget notebooks to it

README.md

@@ -25,10 +25,18 @@ from quantem.widget.datasets import show4dstem_gold
 Show4DSTEM(show4dstem_gold())
 ```
 
-Layout: `4dstem/` holds Arina h5 originals plus pre-binned `_npy_bin*` NumPy
-bundles; `haadf/` holds Velox EMD originals plus `_npy` bundles. Every `_npy*`
-bundle ships a `meta.json` (shape, dtype, sampling, units, optics) next to
-`data.npy`.
+Layout — two trees:
+
+- **`widget-tutorials/<widget>/<dataset>/<size>/`** — baseline tutorial
+  bundles for the core widgets (`show1d/`, `show4dstem/`, `showfolder/`;
+  data shared by Show2D and Show3D lives under `shared/`). These back the
+  one-call loaders in `quantem.widget.datasets` and the Colab workshops.
+  Baseline tutorials only — real work uses your own data.
+- **`4dstem/`, `haadf/`** — full-size originals (Arina h5, Velox EMD) for
+  power users.
+
+Every NumPy bundle ships a `meta.json` (shape, dtype, sampling, units,
+optics) next to `data.npy`.
 
 Workshop notebooks (Google Colab, no local install):
 [Show4DSTEM demo](https://colab.research.google.com/gist/bobleesj/54864ce5b2a6f0a4fd5ae1e5d5719b45/show4dstem_colab.ipynb)

notebooks/show4dstem_colab.ipynb

@@ -2,65 +2,107 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "view-in-github",
+    "colab_type": "text"
+   },
+   "source": [
+    "<a href=\"https://colab.research.google.com/gist/bobleesj/54864ce5b2a6f0a4fd5ae1e5d5719b45/show4dstem_colab.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "source": [
+    "\n"
+   ],
+   "metadata": {
+    "id": "9v3stk4rtjWV"
+   },
+   "id": "9v3stk4rtjWV",
+   "execution_count": null,
+   "outputs": []
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "UFA9PcrTth-d"
+   },
    "source": [
     "# Show4DSTEM in Google Colab\n",
     "\n",
     "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/?url=https%3A%2F%2Fhuggingface.co%2Fdatasets%2Fbobleesj%2Fquantem-data%2Fresolve%2Fmain%2Fnotebooks%2Fshow4dstem_colab.ipynb)\n",
     "\n",
     "Open a 4D-STEM dataset in your browser - **no install, no GPU setup**. Runs on Colab's\n",
-    "Open a 4D-STEM dataset in your browser - **no install, no GPU setup**. On Colab's free **Tesla T4**, Show4DSTEM runs on the **GPU via PyTorch (CUDA)** - NumPy is only the input format; it is uploaded to the GPU. (On a CPU-only runtime it falls back to CPU.)\n",
+    "free runtime. Backend auto-detects; this sample uses the CPU/numpy path so it works on\n",
     "any runtime (CPU or GPU).\n"
-   ]
+   ],
+   "id": "UFA9PcrTth-d"
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "kf5G4BjLth-e"
+   },
    "source": [
     "## 1. Install (one cell)\n"
-   ]
+   ],
+   "id": "kf5G4BjLth-e"
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "id": "IdKh-J1Vth-f"
+   },
    "outputs": [],
    "source": [
     "!pip install -U -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple \"quantem.widget>=0.0.1rc0\" huggingface_hub\n"
-   ]
+   ],
+   "id": "IdKh-J1Vth-f"
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "FWyzquw4th-f"
+   },
    "source": [
     "## 2. Download a sample + open it\n"
-   ]
+   ],
+   "id": "FWyzquw4th-f"
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "id": "nbE-phyvth-f"
+   },
    "outputs": [],
    "source": [
     "import numpy as np\n",
     "from quantem.widget import Show4DSTEM\n",
-    "from quantem.widget.io import download\n",
+    "from huggingface_hub import snapshot_download\n",
     "\n",
-    "path = download('gold_512_npy_bin4')          # ~25 MB from Hugging Face\n",
-    "data = np.load(f'{path}/data.npy')            # (512, 512, 48, 48) 4D-STEM\n",
+    "root = snapshot_download(\"bobleesj/quantem-data\", repo_type=\"dataset\",\n",
+    "                         allow_patterns=[\"widget-tutorials/show4dstem/gold-512-bin4/full/*\"])\n",
+    "path = f\"{root}/widget-tutorials/show4dstem/gold-512-bin4/full\"\n",
+    "data = np.load(f\"{path}/data.npy\")   # (512, 512, 48, 48) uint16, ~1.2 GB\n",
     "Show4DSTEM(data)\n"
-   ]
+   ],
+   "id": "nbE-phyvth-f"
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "dBHvEtxJth-f"
+   },
    "source": [
     "**Interact:** drag the detector ROI (left) -> the virtual image (right) updates live.\n",
     "Drag the scan cursor on the virtual image -> the diffraction pattern follows your finger.\n",
     "\n",
     "To use your own data, upload an Arina `*_master.h5` and run\n",
     "`Show4DSTEM(load('your_master.h5', det_bin=2))` (`from quantem.widget import load`).\n"
-   ]
+   ],
+   "id": "dBHvEtxJth-f"
   }
  ],
  "metadata": {
@@ -75,7 +117,8 @@
   "accelerator": "GPU",
   "colab": {
    "provenance": [],
-   "gpuType": "T4"
+   "gpuType": "T4",
+   "include_colab_link": true
   }
  },
  "nbformat": 4,

notebooks/widget_4dstem_demo.ipynb

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:fab32053ffb7a128c450b55ad2a0f72832092fe86f9c0402acd92c3698422b5c
-size 14104741
+oid sha256:2adc9b05447b74492c68b2fddf1d908771479c1bc6b625d9eb7267a60c4f1cf2
+size 14104794