Installation Instructions

1. Create a conda environment with python 3.13*

conda create -n pyxalign

then activate the environment

conda activate pyxalign

2. Install astra-toolbox, CuPy, and ipykernel from conda-forge:

conda install -c conda-forge astra-toolbox
conda install -c conda-forge cupy
conda install -c conda-forge ipykernel

3. Clone the pyxalign git repo

git clone https://github.com/AdvancedPhotonSource/pyxalign.git

4. Install the package

cd pyxalign
pip install .

For an editable install, use this instead:

cd pyxalign
pip install -e .

To install astra-toolbox and cupy for a specific cuda-toolkit, add cudatoolkit=[version_number] to the end of the conda install commands. For example:

conda install -c conda-forge astra-toolbox cudatoolkit=11.8

This can be helpful when the conda environment is being setup on a machine that is different than the machine where the code will be run.