Metadata-Version: 2.4
Name: livepyxel
Version: 0.1.1
Summary: A GUI tool for dataset preparation / annotation (instance segmentation & ML)
Author-email: Uriel Garcilazo Cruz <garcilazo.uriel@gmail.com>
License: LICENSE
Project-URL: Homepage, https://ugarcil.github.io/LivePyxel/
Project-URL: Issues, https://github.com/UGarCil/LivePyxel/issues
Keywords: annotation,computer-vision,opencv,pyqt5,gui
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: X11 Applications :: Qt
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt5>=5.15
Requires-Dist: opencv-python>=4.5
Dynamic: license-file

# LivePyxel

![logo livePyxel](https://raw.githubusercontent.com/UGarCil/LivePyxel/main/icons/main_logo_long.png)
![software preview](https://raw.githubusercontent.com/UGarCil/LivePyxel/main/icons/gif_view.gif)
LivePyxel is a python-based application, designed for a fast pixel annotation of images taken directly from a webcam feed  

# TUTORIALS
- Using LivePyxel for the first time:  https://ugarcil.github.io/LivePyxel/tutorials.html

## INSTALLATION

You will need a version of python >=3.9 with the following libraries installed:  


&emsp; pyqt5  
&emsp; opencv

I recommend the use of a virtual environment. For a commercial laptop, a good choice is to use Anaconda. Install anaconda for your OS and follow the next steps:  

1. Clone the repository to your computer
2. Open Terminal OR the Anaconda Prompt, and navigate to the folder LivePyxel (if you didn't add Anaconda to the path variables, accessing it via command prompt is not available, but you can use the Anaconda Prompt).

3. Run 
    
```
    conda env create -f requirements.yaml
```
4. Once the new environment has been created, you can type 
```
    conda activate livepyxel-env
```

5. Now you can open the program by entering the measure_curves or measure_lines folder, then execute the python script:  
```
    python main.py
```

# DOCUMENTATION
You can find targeted tutorials for each submodule, and additional information in the official online docs at https://ugarcil.github.io/LivePyxel/
