(reference)=
# 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
: {doc}`interface`, {doc}`menus` and {doc}`shortcuts`: what each part of the window shows, every
  menu entry and every keyboard shortcut.

Your data
: {doc}`session_yaml`, {doc}`input_datasets`, {doc}`output_files` and {doc}`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
: {doc}`command_line`, {doc}`optional_dependencies`, {doc}`plugins` and {doc}`channel_prediction`:
  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 {doc}`../api`.

```{toctree}
:maxdepth: 1

interface
menus
shortcuts
session_yaml
input_datasets
output_files
probe_geometry
command_line
optional_dependencies
plugins
channel_prediction
```