Installation#

diffsims can be installed from Anaconda, the Python Package Index (pip), or from source, and supports Python >= 3.6.

We recommend you install it in a conda environment with the Miniconda distribution:

conda create --name diffsims-env python=3.10
conda activate diffsims-env

If you prefer a graphical interface to manage packages and environments, install the Anaconda distribution instead.

Anaconda#

Anaconda provides the easiest installation. In the Anaconda Prompt, terminal or Command Prompt, install with:

conda install diffsims --channel conda-forge

If you at a later time need to update the package:

conda update diffsims

Pip#

To install with pip, run the following in the Anaconda Prompt, terminal or Command Prompt:

pip install diffsims

If you at a later time need to update the package:

pip install --upgrade diffsims

Install from source#

To install diffsims from source, clone the repository from GitHub:

git clone https://github.com/pyxem/diffsims.git
cd diffsims
pip install -e .