Skip to content

docs: show how to open ARINA data with Show4DSTEM in Jupyter - #219

Merged
bobleesj merged 2 commits into
electronmicroscopy:mainfrom
bobleesj:aug-11-show4dstem-jupyter-quickstart
Aug 11, 2026
Merged

docs: show how to open ARINA data with Show4DSTEM in Jupyter#219
bobleesj merged 2 commits into
electronmicroscopy:mainfrom
bobleesj:aug-11-show4dstem-jupyter-quickstart

Conversation

@bobleesj

@bobleesj bobleesj commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

What problem does it solve?

The README demo did not quickly show researchers how to open their own ARINA 4D-STEM data in Jupyter. The documentation intro led with command-line usage, while the pull-request template made the purpose and review path difficult to scan.

What should reviewer(s) do?

  • Confirm the README links to the documentation directly below the demo.
  • Confirm the documentation intro shows the ARINA *_master.h5 → load(...) → Show4DSTEM Jupyter workflow and keeps the command line secondary.
  • Confirm the pull-request template presents only these three visible sections and keeps author guidance hidden.

Verification

  • npm run build
  • Jupyter Book built all 59 sources
  • Documentation navigation check passed all 62 generated pages
  • Official documentation links return HTTP 200
  • PYTHONPATH=src pytest -q: 1,114 passed, 16 skipped; 2 unrelated environment-version failures in ShowPtycho provenance and the MPS fixture
  • Pull-request template diff and rendered structure reviewed

This PR follows the scikit-package workflow for reproducible scientific software.

@bobleesj bobleesj left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check

Comment thread docs/intro.md
The [Show4DSTEM tutorial](tutorials/show4dstem) continues with real public data,
multiple datasets, and export choices; [Load and I/O](api/io) covers memory-aware
options for your own acquisitions.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

toom uch text, keep it shorter.

@bobleesj

Copy link
Copy Markdown
Collaborator Author

make PR title more descirptive and explicit

@bobleesj
bobleesj force-pushed the aug-11-show4dstem-jupyter-quickstart branch from ee6c77b to 51645af Compare August 11, 2026 14:03
@bobleesj bobleesj changed the title docs: guide README readers to Jupyter documentation docs: add ARINA Show4DSTEM Jupyter notebook quick start Aug 11, 2026
@bobleesj bobleesj changed the title docs: add ARINA Show4DSTEM Jupyter notebook quick start docs: show how to open ARINA data with Show4DSTEM in Jupyter Aug 11, 2026
@bobleesj
bobleesj force-pushed the aug-11-show4dstem-jupyter-quickstart branch from 5581cec to 0a698c4 Compare August 11, 2026 14:15
@bobleesj
bobleesj force-pushed the aug-11-show4dstem-jupyter-quickstart branch from 0a698c4 to f6f7802 Compare August 11, 2026 14:15
@bobleesj
bobleesj merged commit 396dc7a into electronmicroscopy:main Aug 11, 2026
1 check passed
@bobleesj
bobleesj deleted the aug-11-show4dstem-jupyter-quickstart branch August 11, 2026 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant