quantem-data / README.md
bobleesj's picture
Upload README.md with huggingface_hub
1295303 verified
---
license: cc-by-4.0
task_categories:
- image-classification
- image-segmentation
tags:
- electron-microscopy
- 4D-STEM
- materials-science
- quantem
pretty_name: quantem-data
size_categories:
- 1K<n<10K
---
# quantem-data
Real electron microscopy datasets for [quantem.widget](https://github.com/bobleesj/quantem.widget) and [quantem](https://github.com/electronmicroscopy/quantem).
## 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, cached locally)
Show4DSTEM(load("srtio3_lamella"), scan_shape=(32, 32))
# Bright-field image
Show2D(load("srtio3_bf"))
```
## Folder Structure
| Folder | Data type | quantem.widget |
|--------|-----------|----------------|
| `4dstem/` | 4D-STEM diffraction | Show4DSTEM, Show4D |
| `hrtem/` | High-resolution TEM | Show2D, Mark2D |
| `eels/` | Electron energy loss | Show1D |
| `tomo/` | Tomography | Show3DVolume |
| `diffraction/` | Diffraction patterns | Show2D |
| `image/` | Virtual/derived images | Show2D, Mark2D |
| `complex/` | Ptychography | ShowComplex2D |
| `raw/` | Original instrument files | — |
## Metadata
Every `.npy` file has a paired `.json` sidecar with structured metadata (schema, shape, attribution, calibration).
## Contributing
Upload via Python API or CLI. See [quantem.data docs](https://github.com/bobleesj/quantem.data).