Metadata-Version: 2.1
Name: wettingfront
Version: 1.2.0
Summary: Wetting front analysis tool
Author-email: Jisoo Song <jeesoo9595@snu.ac.kr>
License: BSD 2-Clause License
        
        Copyright 2024, Jisoo Song
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/JSS95/wettingfront
Project-URL: source, https://github.com/JSS95/wettingfront
Project-URL: documentation, https://wettingfront.readthedocs.io
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Hydrology
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib_metadata; python_version < "3.10"
Requires-Dist: importlib_resources; python_version < "3.10"
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: PyYAML
Provides-Extra: img
Requires-Dist: imageio; extra == "img"
Requires-Dist: av; extra == "img"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: wettingfront[img]; extra == "test"
Provides-Extra: doc
Requires-Dist: furo; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-autoapi; extra == "doc"
Requires-Dist: sphinx-tabs>=3.4.5; extra == "doc"
Requires-Dist: matplotlib; extra == "doc"
Requires-Dist: pandas; extra == "doc"
Requires-Dist: wettingfront[img]; extra == "doc"
Provides-Extra: dev
Requires-Dist: flake8; extra == "dev"
Requires-Dist: flake8-docstrings; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: docformatter; extra == "dev"
Requires-Dist: doc8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Requires-Dist: wettingfront[doc,test]; extra == "dev"

# WettingFront

[![License](https://img.shields.io/github/license/JSS95/wettingfront)](https://github.com/JSS95/wettingfront/blob/master/LICENSE)
[![CI](https://github.com/JSS95/wettingfront/actions/workflows/ci.yml/badge.svg)](https://github.com/JSS95/wettingfront/actions/workflows/ci.yml)
[![CD](https://github.com/JSS95/wettingfront/actions/workflows/cd.yml/badge.svg)](https://github.com/JSS95/wettingfront/actions/workflows/cd.yml)
[![Docs](https://readthedocs.org/projects/wettingfront/badge/?version=latest)](https://wettingfront.readthedocs.io/en/latest/?badge=latest)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/wettingfront.svg)](https://pypi.python.org/pypi/wettingfront/)
[![PyPI Version](https://img.shields.io/pypi/v/wettingfront.svg)](https://pypi.python.org/pypi/wettingfront/)

![title](https://wettingfront.readthedocs.io/en/latest/_images/index-1.png)

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
    model: Washburn
    path: your-video.mp4
    output-vid: result.mp4
    output-data: result.csv
data2:
    type: MyType
    my-parameters: ...
data3:
    ...
```

Pass the file to command:

```
$ wettingfront analyze config.yml
```

You can also define your own analysis type by [writing a plugin](https://wettingfront.readthedocs.io/en/latest/plugin.html).

## Installation

WettingFront can be installed using `pip`.

```
$ pip install wettingfront
```

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

```
$ pip install wettingfront[img]
```

Other optional dependencies are listed in [manual](https://wettingfront.readthedocs.io/en/latest/intro.html#installation).

## Documentation

Wettingfront is documented with [Sphinx](https://pypi.org/project/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.
