https://github.com/joseph-pq/awive

Adaptive Water Image Velocimetry Estimator for river flow measurements
https://github.com/joseph-pq/awive

flow image-velocimetry python river

Last synced: about 1 year ago
JSON representation

Adaptive Water Image Velocimetry Estimator for river flow measurements

• Host: GitHub
• URL: https://github.com/joseph-pq/awive
• Owner: joseph-pq
• License: mit
• Created: 2021-11-09T05:42:26.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-13T02:12:42.000Z (about 1 year ago)
• Last Synced: 2025-04-13T02:25:39.455Z (about 1 year ago)
• Topics: flow, image-velocimetry, python, river
• Language: Python
• Homepage: https://joseph-pq.github.io/awive/
• Size: 1.06 MB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# AWIVE

[![python](https://img.shields.io/badge/-Python_3.9-blue?logo=python&logoColor=white)](https://docs.python.org/3.9/)

[![opencv](https://img.shields.io/badge/OpenCV_4.6-ee4c2c?logo=opencv&logoColor=white)](https://opencv.org/releases/)




[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![pre-commit](https://img.shields.io/badge/Pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)




[![Code Quality](https://github.com/joseph-pq/awive/actions/workflows/code-quality.yml/badge.svg)](https://github.com/joseph-pq/awive/actions/workflows/code-quality.yml)

[![Tests](https://github.com/joseph-pq/awive/actions/workflows/tests.yaml/badge.svg)](https://github.com/joseph-pq/awive/actions/workflows/tests.yaml)

[![codecov](https://codecov.io/gh/joseph-pq/awive/graph/badge.svg?token=JYOVV0D79Iq)](https://codecov.io/gh/joseph-pq/awive)




[![license](https://img.shields.io/badge/License-MIT-green.svg?labelColor=gray)](https://github.com/nathanpainchaud/lightning-hydra-template?tab=MIT-1-ov-file)






AWIVE, an acronym for Adaptive Water Image Velocimetry Estimator, is a

software package designed for estimating the velocity field from a sequence of

images. It comprises two methods: STIV and OTV, both geared towards achieving

velocity estimations with low computational costs.

## Installing

Install and update using pip:

```bash

pip install awive

```

## Usage

If you want to know how to configure the json file, use the [awive configurator](https://github.com/JosephPenaQuino/awive-configurator)

Execute the commands below:

```

pyenv local 3.11.2

poetry install

poetry run python -m awive.otv river-brenta d0000 -v

```