Installation

Note

gwsnr supports Python 3.10+ (but 3.11 recommended) and utilizes multi-core CPUs and NVIDIA GPUs (or Apple Silicon GPUs) when available.

For package development and contribution refer here (gwsnr for development).

pip install gwsnr

pip install gwsnr jax jaxlib
pip install -U "jax[cuda12]" # optional, for Nvidia GPU support

pip install gwsnr mlx

pip install gwsnr jax jaxlib ripplegw

pip install gwsnr scikit-learn tensorflow
pip install --upgrade ml-dtypes # optional, for compatibility

This will also install the dependencies needed by the lastest gwsnr version.

gwsnr for development

To install gwsnr for development purposes use github.gwsnr. Use conda environment to avoid dependency error.

git clone https://github.com/hemantaph/gwsnr.git
cd gwsnr
conda env create -f gwsnr.yml
conda activate gwsnr
pip install -e .

git clone https://github.com/hemantaph/gwsnr.git
cd gwsnr
conda env update --file gwsnr.yml
pip install -e .