Skip to content

Brkraw Viewer

BrkRaw Viewer is a lightweight GUI for browsing and inspecting Bruker datasets with a focus on stability and a clean separation between the core viewer and optional extensions.

Its intent is simple: keep inspection fast and local, while delegating repeatable workflows to the brkraw CLI and extension ecosystem.

Highlights

  • Load Bruker study folders, archives, or PvDatasets packages
  • Inspect scan metadata and parameter tables
  • Preview image volumes with orientation controls
  • Convert datasets with configurable naming/layout
  • Optional extensions via brkraw.viewer.hook entry points (no core edits required)

Why these features exist

Viewer The Viewer tab gives quick visual confirmation of orientation and scan content so researchers can make decisions before running heavier pipelines.

Registry The Registry exists to reduce repetitive filesystem navigation. It stores datasets you care about and lets you reload the current session in one click.

Extensions/hooks Extensions are delivered as viewer hooks discovered via the brkraw.viewer.hook entry point. Hooks can add new tabs and dataset callbacks without changing the core viewer, and they coexist with converter hooks and CLI hooks so UI features can build on the same rule/spec system as brkraw. For converter hooks, the Convert tab can render hook option forms when the hook exposes presets. Example (minimal):

from dataclasses import dataclass
from typing import Any, Dict

@dataclass
class Options:
    reference: str = "water"
    peak_ppm: float = 3.02

def _build_options(kwargs: Dict[str, Any]) -> Options:
    return Options(
        reference=str(kwargs.get("reference", "water")),
        peak_ppm=float(kwargs.get("peak_ppm", 3.02)),
    )

Getting started

Install the package and run:

brkraw viewer

The main tabs are Viewer, Addon, Params, Convert, and Config. Viewer hooks appear under the Extensions tab and are selected manually.