Installation

autoray is available on both pypi and conda-forge. While autoray is pure python and has no direct dependencies itself, the recommended distribution would be mambaforge for installing the various backend array libraries and their dependencies.

Installing with pip:

pip install autoray

Installing with conda:

conda install -c conda-forge autoray

Installing with mambaforge:

mamba install autoray

Hint

Mamba is a faster version of conda, and the -forge distritbution comes pre-configured with only the conda-forge channel, which further simplifies and speeds up installing dependencies.

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: