add: DashPVA notebooks — Tools Tour, RSM Gridder, and a notebooks index - #159
Conversation
pecomyint
left a comment
There was a problem hiding this comment.
Thanks for keeping this PR isolated to notebooks and documentation. I am requesting a few focused corrections before merge. In the RSM notebook, pass an explicit frame (for example, frame=0) to RSMConverter.get_sample_and_detector_circles, because the current call does not match the required API. Please construct MaskManager with a temporary notebook-specific directory; the default can load a user’s active mask, and clear_mask() may delete masks/active_mask.npy. Expand user paths before passing them to h5py, and clear the stale ladida13.h5 notebook outputs. Finally, either guard the Quickstart load_data("your_data_file.h5") call or revise the README claim that the notebooks run top-to-bottom without external data. Please also resolve the Python 3.12 CI failure. These changes preserve the notebook-only scope while making the examples safe and reproducible.
|
All six points are in, as three commits.
|
pecomyint
left a comment
There was a problem hiding this comment.
APPROVED, BUT PLEASE FIX THESE BEFORE MERGING: guard or skip all later Quickstart cells when data is unavailable, because it still cannot run top-to-bottom without a real file. ALSO CLEAR THE SIX SAVED OUTPUTS AND FIVE EXECUTION COUNTS STILL PRESENT IN RSM_Gridder.ipynb.
…EADME index change: flatten notebooks/dash_analysis/ up to notebooks/ so the three sit together add: figures to the two notebooks that were otherwise all print() — memory-budget curve, built-volume projection with a log intensity histogram, nested 3D isosurfaces, live-grid max projections, mask before/after, and Q-space coverage; the ones that depend on a real scan are guarded and print a hint instead of raising
…ame and returns four values, not two
…letes masks/active_mask.npy
…puts — h5py does not expand ~
…he notebook runs top-to-bottom without a scan file — cell 8 set data=None but the 15 cells after it still dereferenced it
…ipynb — committed outputs bloat the diff and go stale against the code
610fa89 to
9d0d0cb
Compare
Adds a notebooks set for the DashPVA tools, and reorganizes the existing one.
DashPVA_Tools_Tour.ipynb(new) — tour of the toolset.RSM_Gridder.ipynb(new) — building a gridded reciprocal-space volume, including a 3D volume render of the live grid.README.md(new) — index for the notebooks directory.DashAnalysis_Quickstart.ipynb— moved up fromnotebooks/dash_analysis/tonotebooks/, and revised; the now-redundantnotebooks/dash_analysis/README.mdis folded into the new index.Notebooks only — nothing under
src/, so no version bump.