Installing alchemlyb

alchemlyb is available via the pip and conda package managers and can easily be installed with all its dependencies. Alternatively, it can also be directly installed from source

conda installation

install with conda anaconda package platforms last updated

The easiest way to keep track of all dependencies is to install alchemlyb as a conda package from the conda-forge (alchemlyb) channel

conda install -c conda-forge alchemlyb

You can later update your installation with

conda update -c conda-forge alchemlyb

Managing the JAX Dependency

By default, the conda installation of alchemlyb includes the JAX library for accelerated performance. If you encounter dependency conflicts or prefer a leaner installation, you can manage this dependency.

To install without JAX, specify the core build. This version offers the basic functionality without the JAX-based acceleration.

conda install -c conda-forge 'alchemlyb=*=core_*'

To explicitly install with JAX, you can specify the jax build. This is useful to ensure you’re getting the accelerated version.

conda install -c conda-forge 'alchemlyb=*=jax_*'

pip installation

Install via pip from PyPi (alchemlyb)

pip install alchemlyb

Update with

pip install --update alchemlyb

Installing from source

To install from source, first clone the source code repository https://github.com/alchemistry/alchemlyb from GitHub with

git clone https://github.com/alchemistry/alchemlyb.git

and then install with pip

cd alchemlyb
pip install .