Synthetic river flow videos dataset

###### ######### ########## ###### ######### ##########
 Synthetic river flow videos for evaluating image-based velocimetry methods
###### ######### ########## ###### ######### ##########
# Year      : 2022
# Authors   : G.Bodart ([e-mail]), J.Le Coz ([e-mail]), M.Jodeau ([e-mail]), A.Hauet ([e-mail])

###
This file describes the data attached to the article

### -> 00_article_cases
########################
  This folder contains the data used in the case studies: synthetic videos + reference files.

    - 00_reference_velocities
        -> Reference velocities interpolated on a regular grid. Data are given in conventionnal units, i.e. m/s and m.

    - 01_XX
        -> Data of the first case study

    - 02_XX
        -> Data of the second case study

### -> 01_dev
#############
  This folder contains the Python libraries and Mantaflow modified source code used in the paper. The libraries are provided as is. Feel free to contact us for support or guidelines.

    - lspiv
        -> Python library used to extract, process and display results of LSPIV analysis carried out with Fudaa-LSPIV

    - mantaflow-modified
        -> Modified version of Mantaflow described in the article. Installation instructions can be found at http://mantaflow.com

    - syri
        -> Python library used to extract, process and display fluid simulations carried out on Mantaflow and Blender. (Require the lspiv library)

### -> 02_dataset
#################
  This folder contains synthetic videos generated with the method described in the article. The fluid simulation parameters, and thus the reference velocities, are the same as those presented in the article.  

  - The videos can be used freely. Please consider citing the corresponding paper.