Document retired duplicate inputs and active compatibility paths
Browse files
README.md
CHANGED
|
@@ -25,7 +25,7 @@ models, benchmarks and result reports belong in the owning software repository.
|
|
| 25 |
| Show4DSTEM reduced gold scan | `4dstem/gold_128_npy_bin8` | [Show4DSTEM](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/show4dstem.ipynb) |
|
| 26 |
| Calibrated 4D-STEM denoising | `denoise/simulated_au_nanobeam_pg_dose1` | [Denova tutorials](https://github.com/bobleesj/denoise/tree/main/docs/tutorials) |
|
| 27 |
|
| 28 |
-
The shared HAADF image
|
| 29 |
The reduced gold diffraction input similarly provides one source for explicit
|
| 30 |
scan strides. These choices do not imply a new detector calibration or a smaller
|
| 31 |
network transfer. Keep HDF5 masters and linked shards together. Retain metadata
|
|
@@ -39,11 +39,19 @@ loader. Follow the compatible source tutorial for each format.
|
|
| 39 |
|
| 40 |
## Migration and reproducibility
|
| 41 |
|
| 42 |
-
The `widget/` paths add destinations for already-public inputs.
|
| 43 |
paths remain available during the coordinated transition. No unique numerical
|
| 44 |
input is added, removed, resimulated or recompressed by this step. Shared
|
| 45 |
`haadf/`, `4dstem/` and `denoise/` inputs remain in place.
|
| 46 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 47 |
Older notebooks use `widget-tutorials/` or `survey/`. Reproduce them with their
|
| 48 |
matching software and revision `475260be22b5a00704f58382517a44aff94e252e`. New examples must use the qualified ID
|
| 49 |
and exact revision recorded by their compatible tutorial. Do not combine a
|
|
|
|
| 25 |
| Show4DSTEM reduced gold scan | `4dstem/gold_128_npy_bin8` | [Show4DSTEM](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/show4dstem.ipynb) |
|
| 26 |
| Calibrated 4D-STEM denoising | `denoise/simulated_au_nanobeam_pg_dose1` | [Denova tutorials](https://github.com/bobleesj/denoise/tree/main/docs/tutorials) |
|
| 27 |
|
| 28 |
+
The shared HAADF image has one canonical input; size choices are local loader previews.
|
| 29 |
The reduced gold diffraction input similarly provides one source for explicit
|
| 30 |
scan strides. These choices do not imply a new detector calibration or a smaller
|
| 31 |
network transfer. Keep HDF5 masters and linked shards together. Retain metadata
|
|
|
|
| 39 |
|
| 40 |
## Migration and reproducibility
|
| 41 |
|
| 42 |
+
The `widget/` paths add destinations for already-public inputs. Active legacy
|
| 43 |
paths remain available during the coordinated transition. No unique numerical
|
| 44 |
input is added, removed, resimulated or recompressed by this step. Shared
|
| 45 |
`haadf/`, `4dstem/` and `denoise/` inputs remain in place.
|
| 46 |
|
| 47 |
+
The unused `widget-tutorials/show4dstem/gold-512-bin4/full` and
|
| 48 |
+
`widget-tutorials/show4dstem/gold-512-bin8/full` copies have been removed from
|
| 49 |
+
`main`. Their identical data and metadata remain at `4dstem/gold_512_npy_bin4`
|
| 50 |
+
and `4dstem/gold_512_npy_bin8`, respectively. The remaining `widget-tutorials/`
|
| 51 |
+
and `survey/` aliases are still needed by published downloaders; `.thumbnails/`
|
| 52 |
+
still supplies catalog previews. Retire these only after compatible downloaders
|
| 53 |
+
are available. No new data was uploaded and no unique scientific input was lost.
|
| 54 |
+
|
| 55 |
Older notebooks use `widget-tutorials/` or `survey/`. Reproduce them with their
|
| 56 |
matching software and revision `475260be22b5a00704f58382517a44aff94e252e`. New examples must use the qualified ID
|
| 57 |
and exact revision recorded by their compatible tutorial. Do not combine a
|