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.

uPrime logo

uPrime

Turbulence is complex. Analysis shouldn't be.

License Version Python PyPI

pip install uprime-piv

then run uprime

uPrime v0.8 GUI

uPrime Jose & Ram, 2026 is a standalone desktop application for post-processing and turbulence analysis of velocity field data from PIV and CFD. Reads Tecplot ASCII .dat (LaVision DaVis) and MATLAB .mat files.

No scripting. No setup. Just analysis.

Key Features

Convergence verification

Cumulative moments at any point, with automatic N* detection.

Large dataset support

Datasets over 4 GB are memory-mapped: 10,000+ snapshots without running out of RAM.

Non-destructive masking

Mask walls, shadows and reflections; the raw data is never modified.

Publication-ready export

PNG at 300 DPI, plus PDF and SVG with editable text.

Standalone executable

A Windows .exe with no Python needed; macOS and Linux install with pip.

Transform & alignment

Rotate, shift and mirror fields to correct camera misalignment.

Full turbulence pipeline

Stresses, TKE budget, spectra, POD, DMD and vortices in one environment.

Multi-case comparison

Overlay earlier results from CSV, with per-case styling and export.

Analysis Modules

  • Mean & Convergence

  • Compare Cases

  • Reynolds Stress Analysis

  • TKE Budget

  • Space-Time Spectral Analysis

  • Anisotropy Invariants Stereo only

  • Correlation Analysis

  • POD Analysis

  • DMD Analysis TR only

  • Vortex Identification

  • Probability Analysis

  • Mask Editor

  • Coordinate Transform

What’s new

What’s new in v0.9.2
  • uprime-piv command alias: the command can now be typed as the package name, uprime-piv, as well as uprime. An existing 0.9.1 install gets it with pip install --upgrade uprime-piv.

  • Install instructions show the run command: the README, the API docs and this site now say that you install uprime-piv but run uprime.

  • Publishing is release-only: a GitHub release is the only trigger for a PyPI upload, and the upload still waits for approval.

  • README images and links pinned to the release tag, so the description frozen into each PyPI release keeps working if files move.

  • PyPI documentation link now opens the user manual.

  • CI actions on Node 24, replacing versions GitHub flagged as deprecated.

Previous releases

v0.9.1 (2026-11-11)

  • Published to PyPI as uprime-piv: pip install uprime-piv installs uPrime and the uprime command on Windows, macOS and Linux.

  • pyFFTW is an optional extra: install it with pip install "uprime-piv[fft]". Without it only the Spatial E(k) using FFT tab is disabled. The Windows executable still bundles it.

v0.9.0 (2026-11-08)

  • Corrected invalid-vector handling: a vector marked invalid is now excluded in every snapshot it is invalid in, not just the first. Statistics produced from .dat data by v0.4.1–v0.8.2 should be recomputed.

  • Installable as a package: pip install -e . gives a uprime command and an importable uprime package.

  • Documented Python API: docs/API.md covers every public function in uprime.core, with a worked example.

  • One grid convention: .dat, .vc7 and .mat all load with row 0 at the smallest y and column 0 at the smallest x.

  • DMD handles gaps like POD, and both report the fraction of filled values.

  • CI on Windows, macOS and Linux.

v0.8.x (2026-09-01 to 2026-09-03)

  • Probability Analysis module (0.8.0): PDF, Flow Direction, Binary Space-Time and Quadrant tabs, with a deadband for indeterminate flow direction. A drawn ROI restricts the computation, not only the display.

  • Manual x/y line entry in Anisotropy Invariants (0.8.1), with the line recorded in the export.

  • Lumley triangle comparison in Compare Cases (0.8.2), with a merged CSV export.

The full history is in the CHANGELOG on GitHub.

Input Formats

  • Tecplot ASCII .dat One file per snapshot, as exported by LaVision DaVis.

  • MATLAB .mat Full time series in one file, classic and v7.3 (HDF5).

  • DaVis .vc7 / .vec Needs lvpyio; works from source or a pip install, not the .exe.

References
  1. Jose, J. T., & Ram, O. (2026). uPrime: Open-source software for velocity field and turbulence analysis from PIV and CFD data (0.9.2) [Computer software]. Transient Fluid Mechanics Laboratory (TFML), Technion. 10.5281/zenodo.19376184