Metadata-Version: 2.1
Name: fringes-gui
Version: 0.2.0
Summary: Graphical user interface for the 'fringes' package.
Home-page: https://github.com/comimag/fringes-gui
License: CC-BY-NC-SA-4.0
Keywords: phase shifting,fringe analysis,fringe projection,deflectometry,computational imaging
Author: Christian Kludt
Requires-Python: >=3.10,<3.12
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: asdf (>=2.14.3,<3.0.0)
Requires-Dist: fringes (>=0.2.1,<0.2.2)
Requires-Dist: opencv-contrib-python (>=4.7.0,<5.0.0)
Requires-Dist: pyqt6 (>=6.4.2,<7.0.0)
Requires-Dist: pyqtgraph (>=0.13.2,<0.14.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface
Project-URL: Repository, https://github.com/comimag/fringes-gui
Description-Content-Type: text/markdown

# Fringes-GUI
![PyPI](https://img.shields.io/pypi/v/fringes-gui)
![GitHub top language](https://img.shields.io/github/languages/top/comimag/fringes-gui)
![Read the Docs](https://img.shields.io/readthedocs/fringes)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
![PyPI - License](https://img.shields.io/pypi/l/fringes-gui)
![PyPI - Downloads](https://img.shields.io/pypi/dm/fringes-gui)

Graphical user interface for the [fringes](https://pypi.org/project/fringes/) package.

## Installation
You can install `fringes-gui` directly from [PyPi](https://pypi.org/project/fringes-gui) via `pip`:

```
pip install fringes-gui
```

## Usage
You import the `fringes-gui` package and call the function `run()`.

```python
import fringes_gui as fgui
fgui.run()
```

Now the graphical user interface should appear:

![Screenshot](https://raw.githubusercontent.com/comimag/fringes-gui/main/docs/GUI.png)\
Screenshot of the GUI.

## Documentation
The documentation can be found here:
https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface

## License
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License

