|
Download README.md from bobleesj/quantem-data: direct link, hf CLI and curl.
- Browser
- Download file 6.31 kB
-
https://huggingface.co/datasets/bobleesj/quantem-data/resolve/refs%2Fpr%2F5/README.md
- Command line
-
hf download hf://datasets/bobleesj/quantem-data@refs/pr/5/README.md
-
curl -L -o README.md https://huggingface.co/datasets/bobleesj/quantem-data/resolve/refs%2Fpr%2F5/README.md
6.31 kB
| license: mit | |
| tags: | |
| - electron-microscopy | |
| - 4D-STEM | |
| - materials-science | |
| - quantem | |
| pretty_name: quantem-data | |
| # QuantEM shared data | |
| Reusable public inputs for QuantEM and Denova tutorials. Downloads need no token. | |
| This repository stores scientific input data, minimal data cards, numerical | |
| metadata, checksums and existing catalog previews. Scientific code, notebooks, | |
| models, benchmarks and result reports belong in the owning software repository. | |
| ## Find the input for your tutorial | |
| | Purpose | Input folder | Source tutorial | | |
| | --- | --- | --- | | |
| | Show1D reconstruction comparison | `widget/ducky` | [Show1D](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/show1d.ipynb) | | |
| | Show2D/Show3D survey session | `widget/gold_session` | [Live folder watching](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/watch_folder.ipynb) | | |
| | Show2D and Show3D gold image | `haadf/gold_haadf_npy` | [Example data](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/download_data.ipynb) | | |
| | Show4DSTEM reduced gold scan | `4dstem/gold_128_npy_bin8` | [Show4DSTEM](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/show4dstem.ipynb) | | |
| | Calibrated 4D-STEM denoising | `denoise/simulated_au_nanobeam_pg_dose1` | [Denova tutorials](https://github.com/bobleesj/denoise/tree/main/docs/tutorials) | | |
| The shared HAADF image has one canonical input; size choices are local loader previews. | |
| The reduced gold diffraction input similarly provides one source for explicit | |
| scan strides. These choices do not imply a new detector calibration or a smaller | |
| network transfer. Keep HDF5 masters and linked shards together. Retain metadata | |
| and checksums beside their inputs. | |
| `quantem.data` owns qualified dataset retrieval and immutable revision pins. | |
| `quantem.gpu` loads native detector acquisitions. `quantem.widget` provides the | |
| viewer helpers; Denova owns calibration and denoising. The Ducky monitor and the | |
| survey-image session are viewer inputs, not raw 4D-STEM acquisitions for the GPU | |
| loader. Follow the compatible source tutorial for each format. | |
| ## Migration and reproducibility | |
| `main` uses the canonical folders listed above. The duplicate | |
| `widget-tutorials/` and `survey/` trees have been removed. Their scientific | |
| inputs remain unchanged under `widget/`, `haadf/` and `4dstem/`; no new data | |
| was uploaded. `.thumbnails/` remains for catalog previews. | |
| Older unpinned widget downloaders may still request the removed paths. | |
| Use the updated canonical-path helpers, or reproduce older tutorials with | |
| their matching software and revision | |
| `475260be22b5a00704f58382517a44aff94e252e`. The helper updates are currently | |
| in development; this data cleanup does not publish a software release. | |
| Do not combine a historical revision with a path first introduced later. | |
| Notebooks, contribution code and developer templates have been removed from | |
| `main`; historical copies remain at revision | |
| `b30a28c295494b51139415d540819c4cbfde49b6`. Current notebooks and contribution | |
| tools belong in [quantem.widget](https://github.com/electronmicroscopy/quantem.widget), | |
| [quantem.data](https://github.com/bobleesj/quantem.data), and | |
| [Denova](https://github.com/bobleesj/denoise). | |
| ## Provenance and credit | |
| Ducky is synthetic. Original simulation tutorial: **Georgios Varnavides**, | |
| [*Trademark ducky dataset* (October 23, 2025)](https://github.com/electronmicroscopy/quantem-tutorials/blob/dbadc111734641226ab0454ed988feaf018e65c4/simulation_notebooks/ducky-dataset.ipynb). | |
| The viewer files contain subsequent reconstruction results; see the Ducky data | |
| card for the separate source-run record and limits of atomic-model provenance. | |
| The synthetic Au nanobeam example was inspired by experimental data from | |
| **Serin Lee and Andrew Barnum**, | |
| [DOI 10.5281/zenodo.18167694](https://doi.org/10.5281/zenodo.18167694). | |
| It contains no experimental measurements and uses an assumed Poisson–Gaussian | |
| recipe, not a validated ARINA detector calibration. Consult its unchanged card | |
| and metadata for scope, units and attribution. This credit does not identify the | |
| collectors of unrelated gold acquisitions in the repository. | |
| ## Acquisition parameters | |
| The 20260423 drift session optics are confirmed via the session HAADF EMD. | |
| 4D-STEM `scan_sampling` is an operator pattern from a sibling SSB session. | |
| | dataset | voltage | probe | CL | scan | scan sampling | det pitch | mag | | |
| | -------------------------------- | -------- | --------- | ------- | ----------- | -------------- | ------------ | ----------- | | |
| | `haadf/gold_haadf_npy` | 300 kV ✓ | 30 mrad ✓ | 91 mm ✓ | 4096² image | 0.0186 nm/px | n/a | FOV 76.2 nm | | |
| | `4dstem/gold_512_npy_bin8` | 300 kV ✓ | 30 mrad ✓ | 91 mm ✓ | 512² | 0.5 Å (op) | 3.68 mrad/px | unknown | | |
| | `4dstem/gold_512_npy_bin4` | 300 kV ✓ | 30 mrad ✓ | 91 mm ✓ | 512² | 0.5 Å (op) | 1.84 mrad/px | unknown | | |
| | `4dstem/gold_512` | 300 kV ✓ | 30 mrad ✓ | 91 mm ✓ | 512² | 0.5 Å (op) | 0.46 mrad/px | unknown | | |
| | `4dstem/gold_30mrad1.3mx04`…`09` | 300 kV | 30 mrad | 91 mm | smaller | (session yaml) | 0.46 mrad/px | 1.3 Mx | | |
| | `haadf/gold_haadf.emd` | 300 kV ✓ | 30 mrad ✓ | 91 mm ✓ | 4096² image | 0.0186 nm/px | n/a | FOV 76.2 nm | | |
| ✓ = confirmed via EMD/yaml. `(op)` = operator pattern, not file-certified. | |
| ## Contributions and license | |
| The repository card declares MIT. Preserve applicable source notices and any | |
| dataset-specific provenance or licensing qualifications; this label does not | |
| establish an otherwise unverified atomic-model license. | |
| New contributions require actual permission and accurate metadata. Record the | |
| collector, sharing permission, acquisition date, shape, dtype and known | |
| calibration; do not invent absent values. The contribution validator and template | |
| are maintained in the `quantem.data` source repository, not distributed as a | |
| Python package inside this dataset. Existing legacy metadata is not rewritten | |
| into a new universal schema. Follow the owning repository's contribution guide | |
| and review the exact data-file list before submitting a change. | |