semvec/pypi-packages huggingface dataset:
pivtestdata 0.5.0
Repository providing PIV test data
Requires Python: >=3.8

# PIV Test Data

This repository provides the interface to PIV test data, which is freely available on the internet, so all credit goes
to the original authors!!! Available datasets in this repository can be found under these links:

* [PIV Challenge 2001](https://www.pivchallenge.org/)
* [ILA Vortex PAIR](https://www.pivtec.com/download.html)
* [ILA Boundary Layer PAIR](https://www.pivtec.com/download.html)

Intended use of this package is to have a convenient interface to PIV sample data to test PIV algorithms.

**Note**, that the data is not stored in this repo but it assists in downloading it from the respective websites on
demand. Once downloaded, the repo helps you to retrieve the file names quickly from a local user folder.

## Installation

You can install this package via:

```bash
pip install pivtestdata
```

or the latest dev version directly from the git repo:

```bash
pip install git+https://github.com/matthiasprobst/piv-test-data.git@main
```

## Usage

Minimal example (for more see the [notebook](docs/Tutorial.ipynb)):

## ToDo

There is more potential sample data here to be added in the future:
[Japanese standard images](http://www.vsj.jp/~pivstd/image-e.html)