A Python package of path-finding algorithms to find the brightest path between points in an image.
To install and get started with the brightest-path-lib, please visit the documentation website.
For more detailed instructions on how to use the brightest-path-lib, please see the API documentation.
Contributions are very welcome. Tests can be run with pytest, please ensure the coverage at least stays the same before you submit a pull request.
To contribute to this package, first checkout the code. Then create a new virtual environment:
- With venv python -m venv brightest-env source brightest-env/bin/activate
- With conda conda create -y -n brightest-env python=3.9 conda activate brightest-env
Now install the package with the testing dependencies:
cd brightest-path-lib
pip install -e '.[test]'
To run the tests:
pytest
If you have any suggestions or encounter any problems, please file an issue along with a detailed description.
Distributed under the terms of the GNU GPL v3.0 license, "brightest-path-lib" is free and open source software.