hyperspy_gui_anywidget

hyperspy_gui_anywidget provides anywidget-based GUI components for HyperSpy and aims to follow the same practical engineering habits as the main HyperSpy project while staying lightweight enough for a focused extension package.

Contents

• User guide
  • Installation
  • Jupyter usage
  • Marimo usage
  • Supported environments
  • Widget model
  • Why ipywidgets is still a dependency
• Development and maintenance
  • Local checks
  • AI agent setup
  • Completion checklist
  • News fragments
  • Documentation scope
  • Design decision: keep ipywidgets
• API reference
  • custom_widgets
  • utils
  • roi
  • axes
  • model
  • preferences
  • tools
  • microscope_parameters

What lives here

• notebook widgets for HyperSpy tools, models, ROI builders, and preferences

• shared anywidget primitives in hyperspy_gui_anywidget/custom_widgets.py

• tests that verify bidirectional trait sync, widget layout behavior, and parity with the sibling ipywidgets implementation

Project resources

• README on GitHub

• Contributing guide

• Issue tracker

Development checks

pre-commit run --all-files
pytest --pyargs hyperspy_gui_anywidget
sphinx-build -W -b html docs docs/_build/html