bobleesj commited on
Commit
cec153e
·
verified ·
1 Parent(s): fcaddfd

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +18 -33
README.md CHANGED
@@ -1,58 +1,43 @@
1
  ---
2
  license: cc-by-4.0
3
- task_categories:
4
- - image-classification
5
- - image-segmentation
6
  tags:
7
  - electron-microscopy
8
  - 4D-STEM
9
  - materials-science
10
  - quantem
11
  pretty_name: quantem-data
12
- size_categories:
13
- - 1K<n<10K
14
  ---
15
 
16
  # quantem-data
17
 
18
- Real electron microscopy datasets for [quantem.widget](https://github.com/bobleesj/quantem.widget) and [quantem](https://github.com/electronmicroscopy/quantem).
19
 
20
- ## Install
21
 
22
- ```bash
23
- pip install quantem-data
24
- ```
25
 
26
- ## Quick Start
27
 
28
  ```python
29
- from quantem.data import load
30
  from quantem.widget import Show4DSTEM, Show2D
 
31
 
32
- # 4D-STEM dataset (9 MB, cached locally)
33
- Show4DSTEM(load("srtio3_lamella"), scan_shape=(32, 32))
 
 
34
 
35
- # Bright-field image
36
- Show2D(load("srtio3_bf"))
37
  ```
38
 
39
- ## Folder Structure
40
-
41
- | Folder | Data type | quantem.widget |
42
- |--------|-----------|----------------|
43
- | `4dstem/` | 4D-STEM diffraction | Show4DSTEM, Show4D |
44
- | `hrtem/` | High-resolution TEM | Show2D, Mark2D |
45
- | `eels/` | Electron energy loss | Show1D |
46
- | `tomo/` | Tomography | Show3DVolume |
47
- | `diffraction/` | Diffraction patterns | Show2D |
48
- | `image/` | Virtual/derived images | Show2D, Mark2D |
49
- | `complex/` | Ptychography | ShowComplex2D |
50
- | `raw/` | Original instrument files | — |
51
-
52
- ## Metadata
53
 
54
- Every `.npy` file has a paired `.json` sidecar with structured metadata (schema, shape, attribution, calibration).
55
 
56
- ## Contributing
 
57
 
58
- Upload via Python API or CLI. See [quantem.data docs](https://github.com/bobleesj/quantem.data).
 
1
  ---
2
  license: cc-by-4.0
 
 
 
3
  tags:
4
  - electron-microscopy
5
  - 4D-STEM
6
  - materials-science
7
  - quantem
8
  pretty_name: quantem-data
 
 
9
  ---
10
 
11
  # quantem-data
12
 
13
+ Reference electron-microscopy datasets for [quantem.live](https://github.com/bobleesj/quantem.live).
14
 
15
+ Two buckets:
16
 
17
+ - **`4dstem/`** — 4D-STEM acquisitions (one folder per dataset: Arina master + data chunks)
18
+ - **`haadf/`** — HAADF survey images
 
19
 
20
+ ## Download with quantem.live
21
 
22
  ```python
23
+ from quantem.live import io
24
  from quantem.widget import Show4DSTEM, Show2D
25
+ import torch
26
 
27
+ # 4D-STEM: download (cached after first time), bin to fit your GPU, browse
28
+ folder = io.download("gold_512") # -> 4dstem/gold_512/
29
+ data = io.load(io.discover_masters(folder)[0], det_bin=2)
30
+ Show4DSTEM(torch.from_dlpack(data.data))
31
 
32
+ # HAADF image
33
+ Show2D(io.read_image(io.download("gold_haadf"))) # -> haadf/gold_haadf.emd
34
  ```
35
 
36
+ From a terminal: `live data list` · `live data download gold_512`.
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
+ ## Current datasets
39
 
40
+ - `4dstem/`: gold_512, gold_30mrad1.3mx04, gold_30mrad1.3mx06, gold_30mrad1.3mx07, gold_30mrad1.3mx09
41
+ - `haadf/`: gold_haadf
42
 
43
+ Run `live data list` for the live set.