Installation#

There are two ways to install the abTEM package, using conda or pip:

Install abTEM using conda:

conda install -c conda-forge abtem

(Instructions on how to install miniconda can be found here.)

Install abTEM using pip:

pip install abtem

Alternatively, if you have git and want to use unreleased features, you can install directly from github:

pip install git+https://github.com/abTEM/abTEM

Optional dependencies#

GPAW (not available on Windows)#

Some features of abTEM, such as calculating potentials from DFT, require a working installation of GPAW. See here for detailed installation instructions.

Install GPAW using conda:

conda install -c conda-forge gpaw

Install GPAW using pip:

pip install gpaw

Install the PAW datasets into the folder <dir> using this command:

gpaw install-data <dir>

GPU (only Nvidia)#

GPU calculations with abTEM require a working installation of CuPy and compatible hardware. See here for detailed installation instructions.

Install CuPy using conda:

conda install -c conda-forge cupy

First, install the CUDA Toolkit.

Install CuPy using pip:

pip install cupy-cuda*

where * should be substituted for the CUDA Toolkit version.

Development#

See our guide to contributing for instructions on a development installation of abTEM.