imagej / imagej/pyimagej

Consider using magicgui for notebook interactivity

Open
#293 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
534
Forks
95
PR merge metrics
No merged PRs in 30d

Description

We have a couple of notebooks that use the ipywidgets interactive API to render sliders for dynamic computation/visualization:

  • doc/06-Working-with-Images.ipynb
  • doc/09-Working-with-Large-Images.ipynb
  • doc/10-Using-ImageJ-Ops.ipynb

This is fine, but the magicgui project makes it simpler to create more complex sequences of UI components. See https://pyapp-kit.github.io/magicgui/generated_examples/notebooks/magicgui_jupyter/

Should we switch over?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review doc/06-Working-with-Images.ipynb, doc/09-Working-with-Large-Images.ipynb, and doc/10-Using-ImageJ-Ops.ipynb, then compare their ipywidgets interactive usage with the linked magicgui Jupyter examples. Establish whether switching is appropriate and define completion as an agreed approach applied consistently to the affected notebooks.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.