Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,79 @@
+---
+language: en
+license: cc-by-4.0
+tags:
+  - electron-microscopy
+  - 4d-stem
+  - materials-science
+  - quantem
+pretty_name: quantem example datasets
+size_categories:
+  - 1K<n<10K
+---
+
+# quantem-data
+
+Real electron microscopy datasets for [quantem](https://github.com/electronmicroscopy/quantem) widgets.
+
+## Install
+
+```bash
+pip install quantem-data
+```
+
+## 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))
+
+# Bright-field image (64 KB)
+bf = load("arina_bf_128x128")
+Show2D(bf)
+```
+
+## Available datasets
+
+| 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 |
+
+## Technique folders
+
+| 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 |
+
+## Contributing data
+
+```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
+
+All datasets are shared under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) unless otherwise noted in the dataset metadata.