Installation

Basic Setup

JaxSGMC can be installed with pip:

pip install jax-sgmc --upgrade

The above command installs Jax for CPU.

To be able to run JaxSGMC on the GPU, a special version of Jax has to be installed. Further information can be found in Jax Installation Instructions.

Additional Packages

Some parts of JaxSGMC require additional packages:

Data Loading with tensorflow:

pip install jax-sgmc[tensorflow] --upgrade

Saving Samples in the HDF5-Format:
```
pip install jax-sgmc[hdf5] --upgrade
```

Installation from Source

For development purposes, JaxSGMC can be installed from source in editable mode:

git clone git@github.com:tummfm/jax-sgmc.git
pip install -e .[test,docs]

This command additionally installs the requirements to run the tests:

pytest tests

And to build the documentation (e.g. in html):

make -C docs html