Metadata-Version: 2.4
Name: pyfitit_gui
Version: 0.1.4
Summary: a PyQT-based GUI for the pyfitit package
Author-email: Michał Wroński <mwronski@student.agh.edu.pl>
License-Expression: GPL-3.0
Project-URL: Homepage, https://github.com/Sfonxu/pyfitit-gui
Project-URL: Documentation, https://sfonxu.github.io/pyfitit-gui/
Project-URL: Repository, https://github.com/Sfonxu/pyfitit-gui.git
Project-URL: Tracker, https://github.com/Sfonxu/pyfitit-gui/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyfitit
Requires-Dist: PyQT5
Dynamic: license-file

# PyFitIt GUI
This project aims to add a graphical user interface to the [PyFitIt](https://github.com/gudasergey/pyFitIt) package. This application currently features:
 - The ability to create project files for the inverse method, including:
     - The ability to add and edit deformations
	 - Basic tooltips for many input fields

<b>NOTE: Most features are still in an unfinished state.</b>

## Installation
In order to install the package, you can use the pip package manager:
```bash
pip install pyfitit-gui
```
or download the source code files. Then, in the source code folder after creating a virtual environment use:
```bash
pip install . 
```
to install the package.

## Usage
After installing, launch the app by typing `pyfitit-gui` in your terminal.

## Documentation
Code documentation is generated via [pdoc](https://pdoc.dev/). This repo also contains a hand-written manual describing PyFitIt, and in the future it will also contatin a chapter on PyFitIt GUI.

## License
This code is availible under the GNU GPL v3 license as stated in the LICENSE file.
