Reference

These pages describe every part of the GUI, its inputs and its outputs. Unlike the tutorials and how-to guides, they don’t walk you through anything: they’re here to look things up, such as the name of a dataset key, what a menu entry does or which file a result is written to.

The pages are grouped by topic:

The GUI

Interface, Menus and Keyboard shortcuts: what each part of the window shows, every menu entry and every keyboard shortcut.

Your data

Session YAML, Input datasets, Output files and Probe geometry: how to point the GUI at your data, the files it reads and writes, and how it works out the layout of the probe.

Running and extending the GUI

Command line, Optional dependencies, Plugins and Channel prediction plugin: the commands and their options, the optional extras, and the plugins that come with the GUI.

The Python API, generated from the code, is documented in API Reference.

• Interface
• Menus
• Keyboard shortcuts
• Session YAML
• Input datasets
• Output files
• Probe geometry
• Command line
• Optional dependencies
• Plugins
• Channel prediction plugin