Skip to content

Latest commit

 

History

History
162 lines (145 loc) · 6.99 KB

downloads.md

File metadata and controls

162 lines (145 loc) · 6.99 KB
layout default
title Software Packages

Software Packages

OpenPIV is available in multiple programming languages and platforms. Choose the one that best fits your workflow.

Particle Image Velocimetry (PIV) Software

<!-- Python Package -->
<div class="col-md-6 col-lg-4">
  <div class="card h-100 shadow-sm software-card">
    <div class="card-header bg-primary text-white">
      <h4 class="mb-0"><i class="bi bi-python"></i> Python</h4>
      <span class="badge bg-success">Recommended</span>
    </div>
    <div class="card-body">
      <p class="card-text">Main OpenPIV implementation with modern features and active development.</p>
      <ul class="list-unstyled feature-list">
        <li><i class="bi bi-check-circle-fill text-success"></i> Active development</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> GUI available</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> GPU accelerated</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> Cloud-ready</li>
      </ul>
      
      <div class="github-stats mt-3">
        <img src="https://img.shields.io/github/stars/OpenPIV/openpiv-python?style=social" alt="GitHub stars">
        <img src="https://img.shields.io/pypi/v/openpiv" alt="PyPI version">
      </div>
    </div>
    <div class="card-footer bg-transparent">
      <a href="https://github.com/OpenPIV/openpiv-python" class="btn btn-primary btn-sm me-2" target="_blank">
        <i class="bi bi-github"></i> GitHub
      </a>
      <a href="https://pypi.org/project/OpenPIV/" class="btn btn-outline-primary btn-sm" target="_blank">
        <i class="bi bi-download"></i> PyPI
      </a>
    </div>
  </div>
</div>

<!-- TK GUI Package -->
<div class="col-md-6 col-lg-4">
  <div class="card h-100 shadow-sm software-card">
    <div class="card-header bg-success text-white">
      <h4 class="mb-0"><i class="bi bi-window"></i> GUI</h4>
    </div>
    <div class="card-body">
      <p class="card-text">User-friendly graphical interface for OpenPIV Python.</p>
      <ul class="list-unstyled feature-list">
        <li><i class="bi bi-check-circle-fill text-success"></i> Easy to use</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> No coding required</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> Visual workflow</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> Batch processing</li>
      </ul>
    </div>
    <div class="card-footer bg-transparent">
      <a href="https://github.com/OpenPIV/openpiv_tk_gui" class="btn btn-success btn-sm" target="_blank">
        <i class="bi bi-github"></i> GitHub
      </a>
    </div>
  </div>
</div>

<!-- Matlab Package -->
<div class="col-md-6 col-lg-4">
  <div class="card h-100 shadow-sm software-card">
    <div class="card-header bg-warning text-dark">
      <h4 class="mb-0"><i class="bi bi-calculator"></i> Matlab</h4>
      <span class="badge bg-secondary">Legacy</span>
    </div>
    <div class="card-body">
      <p class="card-text">Deprecated since 2021. Use Python version for new projects.</p>
      <ul class="list-unstyled feature-list">
        <li><i class="bi bi-exclamation-circle-fill text-warning"></i> No updates since 2021</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> Stable release</li>
        <li><i class="bi bi-check-circle-fill text-success"></i> Documentation available</li>
      </ul>
    </div>
    <div class="card-footer bg-transparent">
      <a href="https://github.com/OpenPIV/openpiv-matlab" class="btn btn-warning btn-sm me-2" target="_blank">
        <i class="bi bi-github"></i> GitHub
      </a>
      <a href="https://www.openpiv.net/openpiv-matlab" class="btn btn-outline-warning btn-sm" target="_blank">
        <i class="bi bi-book"></i> Docs
      </a>
    </div>
  </div>
</div>

Analysis Toolboxes

Spatial & Temporal Analysis Toolbox

Velocity profiles, spatial correlations, FFT, vorticity contours

Watch screencast
Matlab
<a href="https://github.com/OpenPIV/openpiv-pressure" class="list-group-item list-group-item-action" target="_blank">
  <div class="d-flex w-100 justify-content-between align-items-center">
    <div>
      <h5 class="mb-1"><i class="bi bi-speedometer2"></i> Pressure from PIV</h5>
      <p class="mb-1">Estimate pressure fields from velocity data</p>
    </div>
    <span class="badge bg-primary">Matlab</span>
  </div>
</a>

<a href="https://github.com/OpenPIV/openpiv-podbox" class="list-group-item list-group-item-action" target="_blank">
  <div class="d-flex w-100 justify-content-between align-items-center">
    <div>
      <h5 class="mb-1"><i class="bi bi-diagram-3"></i> POD Toolbox</h5>
      <p class="mb-1">Proper Orthogonal Decomposition analysis</p>
    </div>
    <span class="badge bg-primary">Matlab</span>
  </div>
</a>

<a href="https://github.com/OpenPIV/openpiv-bos" class="list-group-item list-group-item-action" target="_blank">
  <div class="d-flex w-100 justify-content-between align-items-center">
    <div>
      <h5 class="mb-1"><i class="bi bi-image"></i> Background-Oriented Schlieren</h5>
      <p class="mb-1">BOS image processing and analysis</p>
      <small>
        <a href="https://www.openpiv.net/bos/" target="_blank">Introduction</a> | 
        <a href="https://www.openpiv.net/bos/html/BOS_CODE.html" target="_blank">Documentation</a>
      </small>
    </div>
    <span class="badge bg-primary">Matlab</span>
  </div>
</a>
Community Development

All packages are hosted on GitHub. Contributions are welcome! Check out our developer guide to get started.