Anri documentation#

repo platform jax tests codecov style docs

Anri is a Python library for processing polycrystalline diffraction data with JAX.

GitHub Repository License

Installation#

From Conda#

Coming soon!

From source (for developers)#

Anri may (eventually) rely on packages from both conda and pip. For ease of installation, it is recommended to use unidep which can install packages from both sources.

Clone the repository#

git clone git@github.com:jadball/anri.git anri
cd anri

Set up a Conda environment#

conda create -n <env-name>
conda activate <env-name>

Ensure pip is running from the Conda environment#

which pip  # should yield something inside the environment <env-name>

Install build dependencies#

pip install --upgrade pip unidep

Install conda, then pip deps, then the package itself (with dev optional deps) as editable:#

unidep install .[dev]