Installation

Note

The parallelproj package consists of a C/OpenMP (libparallelproj_c) projection library, a CUDA (libparallelproj_cuda) projection library, and a python interface module (parallelproj). We highly recommend to install parallelproj and pre-compiled versions of the libraries and the python interface from conda-forge. which are available for all major operating system (with and without CUDA).

Tip

You can get the miniforge conda install (minimal conda installer specific to conda-forge) here. As usual, we recommend to install parallelproj into a separate virtual environment.

To install parallelproj (and the required compiled libraries) from conda-forge, run

$ mamba install parallelproj
$ conda install -c conda-forge parallelproj

Tip

parallelproj can not only project numpy CPU arrays, but also cupy GPU arrays (no memory transfer between host and GPU needed). To enable the latter, you have to install the cupy package as well.

To install parallelproj and cupy (optional and only if you have a CUDA GPU) from conda-forge, run

$ mamba install parallelproj cupy
$ conda install -c conda-forge parallelproj cupy

Tip

parallelproj can also project pytorch CPU and GPU tensors

To install parallelproj and pytorch (optional) from conda-forge, run

$ mamba install parallelproj pytorch
$ conda install -c conda-forge parallelproj pytorch

Note

In case you are interested in the compiled projection libraries, but not in the python interface, you can install the libparallelproj package from conda-forge.

$ mamba install libparallelproj
$ conda install -c conda-forge libparallelproj