Skip to content

GUI Components

The API docs in this site intentionally focus on the pure-Python and contract heavy modules. For the UI-heavy modules, a short narrative overview is more useful than a large autogenerated class dump.

Main UI Roles

  • cfd_gui.main_window owns user actions, top-level layout, run wiring, status updates, and log presentation.
  • cfd_gui.config_editor turns the schema into the tabbed parameter editor and round-trips widget values.
  • cfd_gui.plot_canvas owns matplotlib embedding, numerical/exact overlays, and figure export behavior.

When To Read These Modules

  • Start with main_window when you need to change toolbar/menu behavior, run lifecycle wiring, or status/log presentation.
  • Start with config_editor when you need to change how schema values become widgets or how widgets round-trip values.
  • Start with plot_canvas when you need to change plotting, figure export, or numerical/exact visualization behavior.
  1. Read the architecture sections in the developer guide.
  2. Read the relevant tests for the behavior you want to change.
  3. Open the UI module only after you know which contract or workflow you are changing.

This keeps the UI layer from feeling more opaque than it really is.