wettingfront 1.0.0

Wetting front image analysis

WettingFront

WettingFront is a simple and extensible Python package for wetting front analysis.

Usage

Store analysis parameters in configuration file (YAML or JSON).

data1:
    type: Unidirectional
    path: your-video.mp4
    output-vid: result.mp4
    output-data: result.csv
data2:
    type: MyType
    my-parameters: ...
data3:
    ...

Pass the file to the command:

$ wettingfront analyze config.yml

You can also define your own analysis type by writing a plugin.

Installation

WettingFront can be installed using pip.

$ pip install wettingfront

To access image processing feature, install with optional dependency [img].

$ pip install wettingfront[img]

Other optional dependencies are listed in manual.

Documentation

Wettingfront is documented with Sphinx. The manual can be found on Read the Docs:

https://wettingfront.readthedocs.io

If you want to build the document yourself, get the source code and install with [doc] dependency. Then, go to doc directory and build the document:

$ pip install .[doc]
$ cd doc
$ make html

Document will be generated in build/html directory. Open index.html to see the central page.