This project is a Python3 implementation for Balu, a computer vision, pattern recognition, and image processing library. Initially implemented in Matlab® by Domingo Mery.
Python 3.10 or higher is required to use this package. Also, it requires to have installed compilation tools:
- Windows: Microsoft C++ build tools (vsbuildtools). You can install it directly from Microsoft website or using Chocolately.
- Linux/MacOS: GCC.
In order to install pybalu, run
$ pip install pybaluIf installation fails, check if the environment has installed setuptools and Cython. In this case, install them:
$ python -m pip install --upgrade setuptools CyhtonWe follow github flow standard. For contributions:
- Fork the repo
- Create a new branch called
feature/<feature-desc>orfix/<fix-desc>depending on the nature of your contribution - Perform a pull request and wait for maintainers accept or reject the contribution
Possible and valuable contributions:
- Tests
- More feature extraction, analysis, and transformation functions
- Fixes
- Documentation
- Examples
The project has switched to Poetry as a packaging and dependency management framework. Please install Poetry before starting work on the contribution. The easiest way to install it is using pipx, but check the Poetry documentation to find the more convenient way for your configuration.
After you have cloned the repository, install it by:
$ poetry installThe installation will include all the dependencies specified in the pyproject.toml
At the end of the contribution, please verify the format running Ruff:
$ poetry run ruff format- Documentation: TODO