Using the GUI

While the SimulationStudy class offers powerful programmatic control, sometimes you just need a clean visual interface to explore your data without writing scripts. The DigiQual App wraps the core statistical engine into a modern, user-friendly graphical interface, allowing you to run the entire lifecycle—from design to diagnostics to reliability analysis—directly in your browser.

1. How to Access the App

Currently, the DigiQual app is bundled directly with the Python package. Depending on your workflow, there are a few ways to launch it.

Option A: Using uv via CLI (Recommended)

If you use uv for environment management, you can launch the app directly from your terminal as a Command Line Interface (CLI) tool. This is the fastest way to get started.

To run the app instantly without permanently installing it to your environment:

uvx -v digiqual@latest

Note: The -v (verbose) flag is highly recommended here! Without it, uvx runs quietly and the app might appear frozen for a few minutes while it downloads the required statistical packages in the background. Also the ‘@latest’ flag will ensure that you have the most recent release

If you plan to use it frequently, you can install it as a persistent global tool on your machine:

uv tool install digiqual
# Once installed, simply type this from any terminal:
digiqual

Linux Users: To ensure the graphical window renders correctly on Linux distributions, you must include the linux-gui extra during installation:

uv tool install "digiqual[linux-gui]"

Option B: From a Python Script

If you are already working inside a Python script or a Jupyter environment, you can launch it locally using the built-in UI function.

# Launch the local application
from digiqual import dq_ui

dq_ui()

This will spin up a local server and automatically open the DigiQual dashboard in your default web browser.

Coming Soon: Standalone Executables We are actively developing standalone, double-click executables for both Windows and macOS. In the near future, you or your colleagues will be able to run the complete DigiQual toolkit as a standard desktop application, without needing to install Python, manage virtual environments, or touch a command line.

Note

Looking for a detailed breakdown of the functionality inside the App? Check out the GUI Desktop Manual.