Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Main Window

Overview

When uPrime launches you will see a welcome screen. The sidebar on the left is your control panel. All steps are numbered in the order you should use them.

uPrime v0.7.0 welcome screen on launch. The sidebar shows Step 1 (Load Data) only. The ‘? Manual‘ button is visible in the top right. Load .dat or .mat files from the sidebar to begin.

Figure 1:uPrime v0.7.0 welcome screen on launch. The sidebar shows Step 1 (Load Data) only. The ‘? Manual‘ button is visible in the top right. Load .dat or .mat files from the sidebar to begin.

Main window after loading a dataset. The Analysis panel lists modules in the recommended order of use, beginning with ‘Mean & Convergence‘ for verifying statistical convergence before moving to higher-order statistics.

Figure 2:Main window after loading a dataset. The Analysis panel lists modules in the recommended order of use, beginning with ‘Mean & Convergence‘ for verifying statistical convergence before moving to higher-order statistics.

Step 1: Load Data

Click ‘Select .dat / .mat Files…‘ to open a file browser. You can select multiple .dat files (one snapshot each) or a single .mat file (full time series). The file type is auto-detected from the extension.

For .dat loads, a subsampling dialog appears next (see Section ??). For .mat loads, the variable confirmation dialog appears (see Section ??).

After loading, the acquisition-type dialog appears. Set ‘TR‘ (time-resolved) or ‘Non-TR‘ and enter the sampling frequency fsf_s if TR.

Acquisition type dialog shown automatically after each data load. Select TR and enter f_s to enable temporal analysis modules. The f_s spinbox is greyed out when Non-TR is selected.

Figure 3:Acquisition type dialog shown automatically after each data load. Select TR and enter fsf_s to enable temporal analysis modules. The fsf_s spinbox is greyed out when Non-TR is selected.

Step 2: Preprocess

Click ‘Transform / Align…‘ to open the coordinate correction tool. This is where you fix camera tilt, shift the coordinate origin, and optionally mirror the dataset. Always do this before running any analysis. Full details are in Chapter ??.

Click ‘Mask Editor…‘ to draw additional spatial masks over regions you want to exclude from analysis (e.g. reflections, shadows, or wall regions not detected by the DaVis isValid flag). Masks are non-destructive: the raw velocity data is never modified. Toggling a mask on or off does not require reloading.

Mask Editor window. The user is drawing a polygon (red) over a region to exclude. Drawing modes include Rectangle, Polygon, Circle, and Ellipse. The mask can be applied inside or outside the drawn shape. Multiple layers can be stacked and each can be undone independently.

Figure 4:Mask Editor window. The user is drawing a polygon (red) over a region to exclude. Drawing modes include Rectangle, Polygon, Circle, and Ellipse. The mask can be applied inside or outside the drawn shape. Multiple layers can be stacked and each can be undone independently.

Main window after applying a drawn mask. The masked region is shown in white. The status bar at the bottom reports the number of mask layers and the fraction of the grid that is masked.

Figure 5:Main window after applying a drawn mask. The masked region is shown in white. The status bar at the bottom reports the number of mask layers and the fraction of the grid that is masked.

Step 3: Analysis

Click any analysis button to open that module in its own window. Multiple analysis windows can be open at the same time and can be compared side by side. The recommended starting point is ‘Mean & Convergence‘ (Chapter ??); from there proceed to Reynolds stresses, TKE budget, and the higher-order modules as appropriate.

All heavy computations (POD, DMD, TKE budget, correlation, vortex identification, probability analysis) run in a background thread so the main window remains fully responsive during computation. A progress indicator appears below the compute button while the calculation is in progress.

Acquisition type and sampling frequency

The acquisition type and sampling frequency fsf_s are set in the dataset info ribbon at the top of the main window, immediately below the field options strip. A dialog to set these values also appears automatically after each data load.

Dataset info ribbon

A compact info strip appears just below the options strip after loading:

Grid: 507 ×\times 248 ⋅\cdot dx/dy: 0.165 mm ⋅\cdot Snapshots: 2000 ⋅\cdot dt: 0.10 ms ⋅\cdot Type: 2D2C ⋅\cdot Memory: ~2012 MB

Field viewer

The right panel shows the selected velocity field as a filled contour plot with optional velocity vectors.

Display controls

Field viewer display controls.

ControlDescription
FieldQuantity to show: Mean U/V/W, speed ∣V∣|V|, vorticity, Std(U), Std(V)
OverlayNone, Vectors, or Streamlines
Draw on contourWhen checked, overlays the selected overlay on the filled contour
Clean exportHides all axis labels, tick marks, and the plot title for a clean exported image
Hide colorbarRemoves the colorbar from the plot
? ManualOpens the user manual PDF

Streamlines

Streamlines trace the instantaneous mean velocity field and give a cleaner visual impression of the flow topology than arrow vectors, especially in regions with complex recirculation.

Toolbar

Toolbar button functions.

ButtonFunction
HomeResets the view to the original limits, regardless of zoom history
Back / ForwardStep through zoom history
PanClick and drag to pan the view
ZoomClick and drag a rectangle to zoom in
SaveSave the figure as PNG (300 DPI), PDF, or SVG

Saving figures

Click the Save button in the toolbar. PNG is saved at 300 DPI. PDF and SVG use vector graphics; all text is saved as editable text and can be restyled in Adobe Illustrator or Inkscape.

Export menu

The ‘Export‘ menu in the menu bar provides one-click export of the time-averaged mean field as a Tecplot ASCII .dat file. The exported file contains ⟨U⟩\langle U \rangle, ⟨V⟩\langle V \rangle, ∣V∣|V|, and (for stereo data) ⟨W⟩\langle W \rangle on the original grid, ready for use in CFD validation, plotting in Tecplot, or import into other PIV tools.

Main window ‘Export‘ menu showing the Tecplot ASCII mean field export option.

Figure 6:Main window ‘Export‘ menu showing the Tecplot ASCII mean field export option.

Snapshot subsampling and large dataset handling

A subsampling dialog appears whenever .dat files are selected, giving you control over how many snapshots to load. The same controls (start, end, step) are available inside the .mat variable confirmation dialog (Section ??).

The dialog shows the estimated snapshot count and memory usage, updating live as you change the options.

After loading, click ‘Select Subset…‘ to adjust the active snapshot range without re-reading from disk.

Large dataset handling (datasets exceeding 4 GB)

When the estimated dataset size after subsampling exceeds 4 GB, uPrime automatically switches to a memory-mapped loading strategy. Instead of loading all velocity data into RAM, uPrime writes the data to a temporary binary file on your system’s temp drive (typically C:\ Users\ username\ AppData\ Local\ Temp) and accesses it as needed. The actual path is shown in the warning label inside the subsampling dialog.

The key practical differences when memory-mapped loading is active: