Upload README.md with huggingface_hub

README.md

@@ -1,19 +1,21 @@
 ---
-language: en
 license: cc-by-4.0
+task_categories:
+  - image-classification
+  - image-segmentation
 tags:
   - electron-microscopy
-  - 4d-stem
+  - 4D-STEM
   - materials-science
   - quantem
-pretty_name: quantem example datasets
+pretty_name: quantem-data
 size_categories:
   - 1K<n<10K
 ---
 
 # quantem-data
 
-Real electron microscopy datasets for [quantem](https://github.com/electronmicroscopy/quantem) widgets.
+Real electron microscopy datasets for [quantem.widget](https://github.com/bobleesj/quantem.widget) and [quantem](https://github.com/electronmicroscopy/quantem).
 
 ## Install
 
@@ -21,59 +23,36 @@ Real electron microscopy datasets for [quantem](https://github.com/electronmicro
 pip install quantem-data
 ```
 
-## Quick start
+## Quick Start
 
 ```python
 from quantem.data import load
 from quantem.widget import Show4DSTEM, Show2D
 
-# 4D-STEM dataset (9 MB, downloads once)
-data = load("arina_32x32_48x48")
-Show4DSTEM(data, scan_shape=(32, 32))
+# 4D-STEM dataset (9 MB, cached locally)
+Show4DSTEM(load("arina_32x32_48x48"), scan_shape=(32, 32))
 
-# Bright-field image (64 KB)
-bf = load("arina_bf_128x128")
-Show2D(bf)
+# Bright-field image
+Show2D(load("arina_bf_128x128"))
 ```
 
-## Available datasets
+## Folder Structure
 
-| Name | Technique | Shape | Size |
-|------|-----------|-------|------|
-| `arina_32x32_48x48` | 4D-STEM | (32,32,48,48) | 9 MB |
-| `arina_64x64_96x96` | 4D-STEM | (64,64,96,96) | 144 MB |
-| `arina_bf_128x128` | Image | (128,128) | 64 KB |
-| `arina_mean_dp_96x96` | Diffraction | (96,96) | 36 KB |
+Mirrors the [quantem](https://github.com/electronmicroscopy/quantem) module structure:
 
-## Technique folders
+| Folder | quantem module | Data types | Widget |
+|--------|---------------|------------|--------|
+| `diffraction/` | `quantem.diffraction` | 4D-STEM, CBED, single DPs | Show4DSTEM, Show4D, Show2D |
+| `diffractive_imaging/` | `quantem.diffractive_imaging` | Ptychography reconstructions | ShowComplex2D |
+| `imaging/` | `quantem.imaging` | HRTEM, BF/DF, virtual images | Show2D, Show3D, Mark2D |
+| `spectroscopy/` | `quantem.spectroscopy` | EELS, EDX spectra | Show1D |
+| `tomography/` | `quantem.tomography` | Tilt series, 3D volumes | Show3DVolume, Show3D |
+| `raw/` | — | Original instrument files | — |
 
-| Folder | Data type | Status |
-|--------|-----------|--------|
-| `4dstem/` | 4D-STEM diffraction | ✅ Data available |
-| `hrtem/` | High-resolution TEM | 📭 Accepting contributions |
-| `eels/` | Electron energy loss | 📭 Accepting contributions |
-| `tomo/` | Tomography | 📭 Accepting contributions |
-| `diffraction/` | Diffraction patterns | ✅ Data available |
-| `image/` | Virtual/derived images | ✅ Data available |
-| `complex/` | Ptychography | 📭 Accepting contributions |
-| `raw/` | Original instrument files | 📭 Accepting contributions |
+## Metadata
 
-## Contributing data
+Every `.npy` file has a paired `.json` sidecar with structured metadata (schema, shape, attribution, calibration).
 
-```python
-from quantem.data import upload
-
-upload(
-    my_array,
-    name="mos2_monolayer",
-    technique="4dstem",
-    description="Monolayer MoS2, 80 keV, Medipix3",
-    contributor="Your Name",
-)
-```
-
-**Naming convention**: `{material}_{descriptor}` — lowercase, underscores only. Material first (e.g. `silicon_110`, `graphene_pristine`). See the [quantem.data README](https://github.com/bobleesj/quantem.data) for full guidelines.
-
-## License
+## Contributing
 
-All datasets are shared under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) unless otherwise noted in the dataset metadata.
+Upload via Python API or CLI. See [quantem.data docs](https://github.com/bobleesj/quantem.data).