arbok-inspector 1.4.0

Browser based QCoDeS database inspector

arbok-inspector 🐍🔎

arbok_inspector is an browser based inspection and visualization utility for QCoDeS measurement databases. It provides a lightweight GUI and CLI to browse runs and visualize data.

Features 🛠️

The most commonly used used tool to visualize QCoDeS databases is plottr. Plottr is a great tool to get started, but struggles with increasing abounts of data.

This is how arbok_inspector streamlines your data inspection:

• Fast browsing of measurement runs and their metadata
• Written with nicegui acting as a tailwind wrapper
• Browser based approach ensures cross system compatibily
• Selected runs are opened in a new tab and run on a separate thread
  • this avoids blocking the entire application when loading big datasets
• plotting backend is plotly which natively returns html
  • plotly plot customization is declarative and can therefore be tweaked in a simple json editor without implementing each customization by hand
• runs are only loaded on demand
  • startup time in plottr can be several minutes for large databases
  • SQL queries load only the given days upon database selection, only loads respective runs once day is selected

Installation 📲

From pypi install using pip in your environment:

pip install arbok-inspector

Even better if you are using uv, a uv.lock file is included!

Launch from CLI:

arbok-inspector

Project layout

• main.py — app entrypoint and startup logic
• state.py — application state & database handling
• pages/ — NiceGUI pages (database browser, run view, greeter, ...)
• widgets/ — reusable UI widgets (grid builders, selectors, dialogs)
• analysis/ — analysis and data-prep utilities
• classes/ — small domain objects used across the app
• helpers/ — formatting and utility helpers

Development & testing 🛠️

Clone this git repository and navigate into it. Use an editable install for local development to pick up changes immediately

pip install -e .

To launch the app in editable mode launch from dev.py file:

arbok-inspector-dev

Note, this will likely not work on Windows! Try python -m dev while being in the arbok_inspector directory.

Contributing & help 🙌

Contributions, bug reports, and small feature requests are welcome. If you want to add a visualization or a new page, use pages/ and widgets/ for examples of how UI components are composed. When opening a PR, please keep changes focused and include a short description of how to exercise the change locally.

License

See the LICENSE file in the project root for license details.