Installation

autoray is available on both pypi and conda-forge. While autoray is pure python and has no direct dependencies itself, the preferred way to install it is with pixi, which creates isolated and reproducible environments that can mix packages from conda-forge (the default) and also pypi.

Installing with pixi (preferred):

pixi init autoray-project
cd autoray-project
pixi add autoray

Installing with pip:

pip install autoray
# or
uv pip install autoray

It is recommended to use uv to install and manage purely pypi based environments.

Installing with conda / mamba:

conda install -c conda-forge autoray

miniforge is the recommended way to manage and install a conda-based environment.

Installing the latest version directly from github:

If you want to checkout the latest version of features and fixes, you can install directly from the github repository:

pip install -U git+https://github.com/jcmgray/autoray.git

Installing a local, editable development version:

If you want to make changes to the source code and test them out, you can install a local editable version of the package:

git clone https://github.com/jcmgray/autoray.git
pip install --no-deps -U -e autoray/

Note

No-install version: The entirety of the automatic dispatch mechanism is contained in the single file autoray.py, which you could simply copy into your project if you don’t want add a dependency.

Optional plotting requirements

The autoray.lazy.draw visualizations variously require: