Advanced installation

Because RoGeR should be usable by both beginners and experts, it has a number of optional dependencies that are not strictly required to run RoGeR, but highly recommended in high-performance contexts.

Note

RoGeR notifies you when a slower code path has to be taken due to a missing dependency. So unless you are getting a warning, there is usually no need to install optional dependencies (except JAX and MPI).

Summary of optional dependencies

Dependency	Supported platforms	When to use
JAX	Linux, OSX, Windows	To run 2x faster on CPU, and for GPU support
MPI + mpi4py	Linux, OSX	To run in parallel
mpi4jax	Linux, OSX	To run in parallel with JAX

Note

On this page, we give all installation instructions via pip install. If you used conda to install RoGeR, consider replacing them with conda install.

Using JAX

Using the JAX backend, RoGeR is typically about 4x faster than with NumPy, so this should be the first thing to try if you want to get more performance.

JAX is available on all major platforms and can be installed via:

$ pip install jax jaxlib

To use JAX on GPU, you have to install a CUDA-enabled version of jaxlib, e.g.:

$ pip install jax jaxlib==0.1.67+cuda111 -f https://storage.googleapis.com/jax-releases/jax_releases.html

(see also the JAX installation guide).

Using MPI

To run RoGeR on more than one process you need to use MPI. This requires that you install an MPI implementation (such as OpenMPI) on your system. Additionally, you have to install mpi4py to interface with it:

$ pip install mpi4py

Then, you can run RoGeR in parallel via MPI.

Using JAX + MPI

To use JAX together with MPI, you need to install mpi4jax after installing mpi4py:

$ pip install mpi4jax