abTEM 1.0.9
*ab*TEM: transmission electron microscopy from first principles
Requires Python: >=3.11

# *ab*TEM: transmission electron microscopy from first principles

[![PyPI version](https://badge.fury.io/py/abTEM.svg)](https://badge.fury.io/py/abTEM)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
<!--- [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jacobjma/abTEM/master?filepath=examples%2Findex.ipynb)--->
<!---[[[[![DOI](https://zenodo.org/badge/205110910.svg)g(https://zenodo.org/badge/latestdoi/2051109--->

[**Docs**](https://abtem.github.io/doc/intro.html)
| [**Install Guide**](https://abtem.github.io/doc/getting_started/install.html)
| [**Walkthrough**](https://abtem.github.io/doc/user_guide/walkthrough/walkthrough.html)
<!---| [**Examples**](https://github.com/jacobjma/abTEM/tree/master/examples)--->

*ab*TEM (pronounced "ab-tem", as in "*ab initio*") provides a Python API for running simulations of (scanning)
transmission electron microscopy images and diffraction patterns using the multislice or PRISM algorithms. It is
designed to closely integrate with atomistic simulations using the Atomic Simulation
Environment ([ASE](https://wiki.fysik.dtu.dk/ase/)), and to directly use *ab initio* electrostatic potentials from the
high-performance density functional theory code [GPAW](https://wiki.fysik.dtu.dk/gpaw/). *ab*TEM is open source, purely
written in Python, very fast, and extremely versatile and easy to extend.

## Installation

You can install *ab*TEM using `pip`:

```sh
$ pip install abtem
```

For detailed instructions on installing *ab*TEM,
see [the installation guide](https://abtem.github.io/doc/intro.html).

## Getting started

To get started using *ab*TEM, please visit
our [walkthrough](https://abtem.github.io/doc/user_guide/walkthrough/walkthrough.html).

<!---To try *ab*TEM in your web browser, please click on the following Binder link:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jacobjma/abTEM/master?filepath=examples%2Findex.ipynb)--->

## Practical guide to simulations

For a pedagogical guide into numerical transmission electron microscopy simulations with extensive use of *ab*TEM code, please see [this computational article](https://www.elementalmicroscopy.com/articles/EM000005).

## Citing *ab*TEM

If you find *ab*TEM useful in your research, please cite our methods article:

J. Madsen & T. Susi, "The abTEM code: transmission electron microscopy from first principles", Open Research Europe 1:
24 (2021), doi:[10.12688/openreseurope.13015.2](https://doi.org/10.12688/openreseurope.13015.2).

## Usage poll

Our code is used by so many people that it is hard to keep track. If you already use or are interested in using *ab*TEM, we'd appreciate if you could fill in our [poll](https://github.com/abTEM/abTEM/discussions/186)!

## Contact

* Write the [maintainer](https://github.com/tomasusi) or [lead developer](https://github.com/jacobjma) directly
* Bug reports and issues: [GitHub issues](https://github.com/abTEM/abTEM/issues)
* Discussion and development: [GitHub discussions](https://github.com/abTEM/abTEM/discussions)

Please send us bug reports, patches, code, ideas and questions.