bobleesj commited on
Commit
3002eca
·
verified ·
1 Parent(s): 7594937

Document shared widget data inputs and source tutorials

Browse files
Files changed (1) hide show
  1. widget/README.md +17 -0
widget/README.md ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Widget example inputs
2
+
3
+ These folders hold reusable input data, not tutorial code.
4
+
5
+ | Folder | Input | Source tutorial |
6
+ | --- | --- | --- |
7
+ | `ducky/` | Synthetic reconstruction monitor events and all referenced numerical snapshots | [Show1D](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/show1d.ipynb) |
8
+ | `gold_session/` | The existing 26-file gold HAADF EMD session | [Live folder watching](https://github.com/electronmicroscopy/quantem.widget/blob/main/docs/tutorials/watch_folder.ipynb) |
9
+
10
+ Show2D and Show3D share `haadf/gold_haadf_npy`; Show4DSTEM uses
11
+ `4dstem/gold_128_npy_bin8`. They do not need duplicate arrays under this folder.
12
+ Locally generated examples remain in the tutorial source. Use the immutable
13
+ data revision and compatible package versions recorded by each tutorial.
14
+
15
+ Keep monitor-relative snapshot paths and original session acquisition filenames
16
+ intact. The Ducky folder is synthetic and carries its own upstream credit;
17
+ consult each folder's card for provenance.