Installation

Prerequisites

• Python: Version >= 3.13 (Support for 3.14 is currently pending taichi backend C-API compiled wheels, but the CPU pipeline works universally).
• Hardware: A dedicated GPU is highly recommended for video and GIF processing, though a CPU fallback is natively provided.

Installation methods

Option 1: Install via PyPI (Recommended)

The easiest way to install the library and the global CLI is directly from the Python Package Index:

pip install BayerDithering

To enable GPU Hardware Acceleration (Recommended for Videos), install the package with the optional taichi backend dependency:

pip install "BayerDithering[gpu]"

Option 2: Build from Source

1. Clone the repository:

   git clone https://github.com/madmattp/Bayer-Dithering.git
   

2. Install the package and its dependencies:

   pip install -e .
   

   (This will install the required libraries and link the dither command to your system).

3. (Optional) Enable GPU Hardware Acceleration:

   pip install -e ".[gpu]"