Installation¶
SymJAX has a couple of prerequisites that need to be installed first.
CPU only installation¶
Installation of SymJAX and all its dependencies (including Jax). For CPU only support is done simply as follows
$ pip install --upgrade jaxlib $ pip install --upgrade jax $ pip install --upgrade symjax
GPU installation¶
For the GPU support, the Jax installation needs to be done first and based on the local cuda settings following Jax Installation. In short, the steps involve
Installation of GPU drivers/libraries/compilers (
cuda
,cudnn
,nvcc
).Install
jax
following Jax Installation.Install SymJAX with
$ pip install --upgrade symjax
Manual (local/bleeding-edge) installation of SymJAX¶
In place of the base installation of SymJAX from the latest official release from PyPi, one can install the latest version of SymJAX from the github repository as follows
Clone this repository with
$ git clone https://github.com/RandallBalestriero/SymJAX
Install.
$ cd SymJAX $ pip install .
Note that whenever changes are made to the SymJAX github repository, one can pull those changes bu running
$ git pull
from within the cloned repository. However the changes won’t impact the installed version unless the install was done with
$ pip install -e .