Install Guide¶

Dependencies¶

ProxImaL has the following dependencies:

Python 3.9
NumPy <= 1.26.0
SciPy >= 0.15
Numexpr
Pillow
cv2

Halide compiler toolchain installation is fully automated as long as the installation path is not root/admin restricted.

To test the ProxImaL installation, you additionally need Pytest and CVXPY.

Install from source¶

Installation is easiest with UV the pip accelerator. First, clone the ProxImaL git repository.

Next, navigate to the top-level of the cloned directory and create a virtual environment by:

cd path/to/ProxImaL/
uv venv --python=3.9
source .venv/bin/activate

Now, install the project to the virtual environment:

source .venv/bin/activate
uv pip install -U -e .

Unit testing¶

To run the unit test cases, reinstall the project by:

cd path/to/ProxImaL/
source .venv/bin/activate
uv pip install -U -e .[test]

This action installs the CVXPY and the Pytest framework.

After installation, run the unit tests:

pytest -rx ./proximal/tests/

Expected test report:

collected 61 items

proximal/tests/test_algs.py ...s.......                                  [ 18%]
proximal/tests/test_cuda_comp_graph.py sssssssssssss                     [ 39%]
proximal/tests/test_cuda_prox_fn.py s                                    [ 40%]
proximal/tests/test_halide.py .......                                    [ 52%]
proximal/tests/test_lin_ops.py ............                              [ 72%]
proximal/tests/test_problem.py ss..                                      [ 78%]
proximal/tests/test_prox_fn.py .........                                 [ 93%]
proximal/tests/test_transforms.py s...                                   [100%]
=========== 43 passed, 18 skipped, 14 warnings in 137.02s (0:02:17) ============