Installation

This section provides instructions for installing the sppcax package.

Requirements

sppcax requires the following dependencies:

To install the stable release of sppcax from PyPI:

$ pip install sppcax

This is the preferred method to install sppcax as it will always install the most recent stable release.

If you want to install the latest development version from the repository:

$ pip install git+https://github.com/username/sppcax.git

For development purposes, you can clone the repository and install it in development mode:

$ git clone https://github.com/username/sppcax.git
$ cd sppcax
$ pip install -e .

This mode allows you to modify the code and have the changes take effect immediately without reinstalling.

To run the tests, additional dependencies are required:

$ pip install -e ".[testing]"

That will install all the extra dependencies needed for testing.

JAX installation may require special consideration depending on your hardware:

For CUDA (NVIDIA GPU) support:

$ pip install --upgrade "jax[cuda]" -f https://storage.googleapis.com/jax-releases/jax_releases.html

Please refer to the JAX installation guide for more details.