Skip to content
Snippets Groups Projects
Commit c977e72d authored by jml1g18's avatar jml1g18
Browse files

added draft README files

parent 619aaa2d
No related branches found
No related tags found
No related merge requests found
# Compiling and running pivtools on IRIDIS
## Dependencies
This code depends on some external libraries:
* fftw
* gsl
To run this code on the IRIDIS compute cluster, you will need to make sure you have loaded appropriate libraries
module load fftw/3.3.7/gcc
module load gsl
module load matlab
To compile it, you will need to make sure MATLAB has the appropriate path to your libraries.
You can check what this is with
module show fftw/3.3.7/gcc
module show gsl
## Installation
# pivtools
MATLAB based 2D and stereo PIV processing, accelerated with C-MEX extensions
# Description
## What is pivtools?
pivtools is a set of tools for 2D planar and stereo PIV, developed at the University of Southampton by Dr. John Lawson since 2018.
There are many other open source projects which offer similar functionality, as well as commercially available softwares.
Notable open source examples are [OpenPIV](https://github.com/OpenPIV) and [PIVLab](https://github.com/Shrediquette/PIVlab)
A curated list of projects is available at the [Awesome Fluid Dynamics list](https://lento234.ch/awesome-fluid-dynamics/#experimental-fluid-dynamics).
## Why use pivtools?
Currently, the main advantages are
* it is fast on CPU-based architectures
* it can do stereo PIV
* processing can be accelerated easily on cluster computing
# Prerequisites and dependencies
pivtools is MATLAB based with compiled MEX extensions.
You will need MATLAB 2022b or later and the following toolboxes:
* Image Processing Toolbox
* Signal Processing Toolbox
* Statistics and Machine Learning Toolbox
Additionally, to build pivtools from source, you will need
* [GNU Scientific Library (GSL)](https://www.gnu.org/software/gsl/)
* [FFTW3](https://www.fftw.org/)
On Ubuntu, you can install these using
sudo apt-get install libfftw3-dev libgsl-dev
# Installation
To install pivtools from source, download a copy of the latest version from the pivtools repositroy
git clone https://git.soton.ac.uk/jml1g18/pivtools.git
pivtools uses compiled MEX functions to accelerate PIV processing.
To build these, you will first need to [set up MATLAB to compile mex extensions](https://uk.mathworks.com/help/matlab/matlab_external/changing-default-compiler.html)
You will then need to edit `make.m` to provide the include and library path to GSL and FFTW
Then, to compile pivtools MEX functions, navigate to your installation directory and run
make.m
# Usage
TODO: add some examples of usage
# Authors and acknowledgement
Contributors
* Dr. John Lawson ( jml1g18@soton.ac.uk )
# License
See LICENSE
# Project status
Active as of October 2023
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment