| layout | title |
|---|---|
default |
Getting Started |
Choose the best way to get started with OpenPIV based on your needs and experience level.
<div class="row g-4">
<!-- Marimo Interactive Notebook -->
<div class="col-md-6">
<div class="card h-100 shadow-sm">
<div class="card-header bg-primary text-white">
<h4 class="mb-0"><i class="bi bi-book"></i> Marimo Interactive Notebook</h4>
</div>
<div class="card-body">
<p>Try OpenPIV in an interactive, modern notebook environment powered by Marimo.</p>
<ul class="list-unstyled">
<li><i class="bi bi-check-circle-fill text-success"></i> No installation needed</li>
<li><i class="bi bi-check-circle-fill text-success"></i> Interactive examples</li>
<li><i class="bi bi-check-circle-fill text-success"></i> Run instantly in browser</li>
<li><i class="bi bi-check-circle-fill text-success"></i> Modern interface</li>
</ul>
</div>
<div class="card-footer bg-transparent">
<a href="https://molab.marimo.io/notebooks/nb_ZpcirbacVvBP3ZgbdCgKhM" class="btn btn-primary" target="_blank">
<i class="bi bi-play-circle"></i> Launch Marimo Notebook
</a>
</div>
</div>
</div>
<!-- Google Colab -->
<div class="col-md-6">
<div class="card h-100 shadow-sm">
<div class="card-header bg-warning text-dark">
<h4 class="mb-0"><i class="bi bi-google"></i> Google Colab</h4>
</div>
<div class="card-body">
<p>Use Google Colab to run OpenPIV with free cloud computing resources.</p>
<ul class="list-unstyled">
<li><i class="bi bi-check-circle-fill text-success"></i> Free GPU access</li>
<li><i class="bi bi-check-circle-fill text-success"></i> Google account required</li>
<li><i class="bi bi-check-circle-fill text-success"></i> Save to Google Drive</li>
<li><i class="bi bi-check-circle-fill text-success"></i> Jupyter notebook format</li>
</ul>
</div>
<div class="card-footer bg-transparent">
<a href="https://colab.research.google.com/github/OpenPIV/openpiv-python-examples/blob/main/notebooks/tutorial1.ipynb" class="btn btn-warning" target="_blank">
<i class="bi bi-google"></i> Open in Colab
</a>
</div>
</div>
</div>
</div>
<div class="row g-4">
<!-- pip Installation -->
<div class="col-md-6">
<div class="card h-100">
<div class="card-body">
<h4><i class="bi bi-box"></i> Using pip</h4>
<p>Install OpenPIV using Python's package manager:</p>
<div class="code-block">
<pre><code>pip install openpiv</code></pre>
<button class="copy-btn" data-clipboard-text="pip install openpiv">
<i class="bi bi-clipboard"></i> Copy
</button>
</div>
<p class="text-muted mt-2"><small>Requires Python 3.7 or newer</small></p>
</div>
</div>
</div>
<!-- conda Installation -->
<div class="col-md-6">
<div class="card h-100">
<div class="card-body">
<h4><i class="bi bi-box"></i> Using conda</h4>
<p>Install OpenPIV using conda package manager:</p>
<div class="code-block">
<pre><code>conda install -c conda-forge openpiv</code></pre>
<button class="copy-btn" data-clipboard-text="conda install -c conda-forge openpiv">
<i class="bi bi-clipboard"></i> Copy
</button>
</div>
<p class="text-muted mt-2"><small>Recommended for Anaconda users</small></p>
</div>
</div>
</div>
</div>
<!-- GUI Installation -->
<div class="alert alert-info mt-4">
<h5><i class="bi bi-window"></i> Want a Graphical Interface?</h5>
<p class="mb-2">Install the TK GUI for a point-and-click experience:</p>
<div class="code-block">
<pre><code>pip install openpiv-tk-gui</code></pre>
<button class="copy-btn" data-clipboard-text="pip install openpiv-tk-gui">
<i class="bi bi-clipboard"></i> Copy
</button>
</div>
<p class="mb-0 mt-2">
<a href="https://github.com/OpenPIV/openpiv_tk_gui" target="_blank">View GUI documentation <i class="bi bi-box-arrow-up-right"></i></a>
</p>
</div>
<div class="list-group">
<a href="https://openpiv.readthedocs.io/" 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-file-text"></i> Official Documentation</h5>
<p class="mb-0">Complete API reference and user guides</p>
</div>
<i class="bi bi-arrow-right"></i>
</div>
</a>
<a href="https://openpiv.readthedocs.io/en/latest/src/tutorial1.html" 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-mortarboard"></i> Tutorial 1: Basic PIV Analysis</h5>
<p class="mb-0">Step-by-step guide to your first PIV analysis</p>
</div>
<i class="bi bi-arrow-right"></i>
</div>
</a>
<a href="https://github.com/OpenPIV/openpiv-python-examples/tree/main/notebooks" 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-journal-code"></i> Example Notebooks</h5>
<p class="mb-0">Collection of Jupyter notebooks with various examples</p>
</div>
<i class="bi bi-arrow-right"></i>
</div>
</a>
<a href="https://video.fh-muenster.de/Panopto/Pages/Viewer.aspx?id=309dccc2-af58-44e0-8cd3-ab9500c5b7f4" 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-play-btn"></i> GUI Video Tutorial</h5>
<p class="mb-0">Learn how to use OpenPivGui (video walkthrough)</p>
</div>
<i class="bi bi-arrow-right"></i>
</div>
</a>
<a href="{{ site.baseurl }}/quickstart.html" class="list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-between align-items-center">
<div>
<h5 class="mb-1"><i class="bi bi-rocket"></i> Quick Start Guide</h5>
<p class="mb-0">Get up and running in 5 minutes</p>
</div>
<i class="bi bi-arrow-right"></i>
</div>
</a>
</div>
<div class="row g-4">
<div class="col-md-4">
<div class="card h-100 text-center">
<div class="card-body">
<i class="bi bi-people" style="font-size: 3rem; color: #667eea;"></i>
<h5 class="mt-3">Community Forum</h5>
<p>Ask questions and get help from the community</p>
<a href="https://groups.google.com/forum/#!forum/openpiv-users" class="btn btn-outline-primary" target="_blank">
Visit Forum
</a>
</div>
</div>
</div>
<div class="col-md-4">
<div class="card h-100 text-center">
<div class="card-body">
<i class="bi bi-github" style="font-size: 3rem; color: #667eea;"></i>
<h5 class="mt-3">GitHub Issues</h5>
<p>Report bugs or request features</p>
<a href="https://github.com/OpenPIV/openpiv-python/issues" class="btn btn-outline-primary" target="_blank">
Open Issue
</a>
</div>
</div>
</div>
<div class="col-md-4">
<div class="card h-100 text-center">
<div class="card-body">
<i class="bi bi-envelope" style="font-size: 3rem; color: #667eea;"></i>
<h5 class="mt-3">Email Support</h5>
<p>Contact the team directly</p>
<a href="mailto:openpiv2008@gmail.com" class="btn btn-outline-primary">
Send Email
</a>
</div>
</div>
</div>
</div>