Skip to content

karlosos/image_vector_quantization

Repository files navigation

logo


Code style: black Run Tests Lint GitHub contributors

Team project where we implemented and experimented with image compression algorithms. Lossless and lossy compression with vector quantization, mean-removal vector quantization, LBG algorithm, differential encoding and Golomb coding.

Development

  1. Create virtual environment with virtualenv .venv.
  2. Activate venv with source .venv/bin/activate.
  3. Install packages with pip install -r requirements.txt.
  4. Activate git hooks with pre-commit install.
  5. Install vector_quantization as a package with pip install -e .. This will allow doing imports like from vector_quantization import ..
  6. Go to vector_quantization subfolder.
  7. Launch application with python main.py.

IMPORTANT: on commiting black formatter and flake8 will check code. To enable this checking run command pre-commit install.

Running tests

Run tests with pytest in root

LaTeX document

  1. Install LaTeX https://www.latex-project.org/get/
  2. Edit docs/template.tex with your editor, for example TeXMaker

Pair programming

Install Live Share extension for VSCode..