CeLux offers one installation options tailored to your system's capabilities:
- CPU-Only Version: For systems without CUDA-capable GPUs.
Install the CPU version of CeLux using pip
:
pip install celux
import celux #as cx
While CeLux is easily installable via pip
, you might want to build it from source for customization or contributing purposes.
-
Clone the Repository:
git clone https://github.com/Trentonom0r3/celux.git cd celux
-
Install Dependencies:
Ensure all prerequisites are installed. You can use
vcpkg
for managing dependencies on Windows. -
Configure the Project with CMake:
cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
Windows Users: If using Vcpkg, include the toolchain file:
cmake -B build -S . -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=<path_to_vcpkg>/scripts/buildsystems/vcpkg.cmake
-
Build the Project:
cmake --build build --config Release
-
Install the Package:
cmake --install build
-
Set Up Environment Variables:
Ensure FFmpeg binaries and other dependencies are in your system's
PATH
. On Unix systems, you might need to setLD_LIBRARY_PATH
orDYLD_LIBRARY_PATH
.