bobleesj commited on
Commit
5925e4b
·
verified ·
1 Parent(s): 86b2904

Document simplified data folders and historical reproducibility

Browse files
Files changed (1) hide show
  1. README.md +14 -23
README.md CHANGED
@@ -39,31 +39,22 @@ 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. 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
58
- historical revision with a path first introduced later. A short name may become
59
- ambiguous while aliases coexist; use its full folder ID. Qualified/revision API
60
- support currently requires the coordinated development checkout until a tested
61
- release is identified.
62
 
63
  Notebooks, contribution code and developer templates have been removed from
64
- `main`; their historical versions remain available at revision
65
- `b30a28c295494b51139415d540819c4cbfde49b6`. Scientific input files are unchanged.
66
- Current notebooks and contribution tools belong in [quantem.widget](https://github.com/electronmicroscopy/quantem.widget),
67
  [quantem.data](https://github.com/bobleesj/quantem.data), and
68
  [Denova](https://github.com/bobleesj/denoise).
69
 
 
39
 
40
  ## Migration and reproducibility
41
 
42
+ `main` uses the canonical folders listed above. The duplicate
43
+ `widget-tutorials/` and `survey/` trees have been removed. Their scientific
44
+ inputs remain unchanged under `widget/`, `haadf/` and `4dstem/`; no new data
45
+ was uploaded. `.thumbnails/` remains for catalog previews.
46
+
47
+ Older unpinned widget downloaders may still request the removed paths.
48
+ Use the updated canonical-path helpers, or reproduce older tutorials with
49
+ their matching software and revision
50
+ `475260be22b5a00704f58382517a44aff94e252e`. The helper updates are currently
51
+ in development; this data cleanup does not publish a software release.
52
+ Do not combine a historical revision with a path first introduced later.
 
 
 
 
 
 
 
 
 
53
 
54
  Notebooks, contribution code and developer templates have been removed from
55
+ `main`; historical copies remain at revision
56
+ `b30a28c295494b51139415d540819c4cbfde49b6`. Current notebooks and contribution
57
+ tools belong in [quantem.widget](https://github.com/electronmicroscopy/quantem.widget),
58
  [quantem.data](https://github.com/bobleesj/quantem.data), and
59
  [Denova](https://github.com/bobleesj/denoise).
60