Installation

Installation Guide

It is advisable to work in a fresh conda environment:

conda create -n split_env python=3.10
conda activate split_env

Then clone the repository and install in editable mode:

git clone https://github.com/perturber/SPLIT.git
cd SPLIT
pip install -e .

Warning: pip install -e .[gpu] will pull eryn and fastemriwaveforms-cuda12x from PyPI at unconstrained versions, which is not what SPLIT expects. Install the pinned dependencies below manually before (or instead of) using the [gpu] extras.

A Note on Dependencies

Eryn: Please use this version of Eryn with a more robust key_order check for loading from backends. See here for the fix. You can install this version of Eryn from source using the following commands:
```
git clone https://github.com/perturber/Eryn.git
cd Eryn
pip install -e .
```
fastlisaresponse: Please use a version of fastlisaresponse which has the option to specify t0 (see definition) and t_buffer (see definition) separately. This package has been validated for the tag v1.2.1a0. It can be pip installed for cuda12x as:
```
pip install --pre fastlisaresponse-cuda12x==1.2.1a0
```
lisaanalysistools: This package has been validated for the tag v1.2.8. lisaanalysistools will try auto-installing a suitable version of cupy. So it is better to install it before any other dependencies. It can be pip installed for cuda12x as:
```
pip install lisaanalysistools-cuda12x==1.2.8
```

FastEMRIWaveforms: This package has been validated for the tag v2.0.0. It can be installed from source as:

git clone https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms.git
cd FastEMRIWaveforms
git checkout v2.0.0
pip install -e '.[dev, testing]'