atomman

AtomMan

Atomistic Manipulation Toolkit

AtomMan: the Atomistic Manipulation Toolkit is a Python library for creating, representing, manipulating, and analyzing large-scale atomic systems of atoms. The focus of the package is to facilitate the rapid design and development of simulations that are fully documented and easily adaptable to new potentials, configurations, etc. The code has no requirements that limit which systems it can be used on, i.e. it should work on Linux, Mac and Windows computers.

Features:

• Allows for efficient and fast calculations on millions of atoms, each with many freely defined per-atom properties.

• Built-in tools for generating and analyzing crystalline defects, such as point defects, stacking faults, and dislocations.

• Call LAMMPS directly from Python and instantly retrieve the resulting data or LAMMPS error statement.

• Easily convert systems to/from the other Python atomic representations, such as ase.Atoms and pymatgen.Structure.

• Can read and dump crystal structure information from a number of formats, such as LAMMPS data and dump files, and POSCAR.

• Built-in unit conversions.

Installation

The atomman package is compatible with Python 3.7+.

The latest release can be installed using pip::

pip install atomman

or using conda from the conda-forge channel::

conda install -c conda-forge atomman

For Windows users, it is recommended to use an Anaconda distribution and use conda to install numpy, scipy, matplotlib, pandas and cython prior to installing atomman.

Alternatively, all code and documentation can be downloaded from GitHub.

• The stable releases are available at https://github.com/usnistgov/atomman <https://github.com/usnistgov/atomman>__.

• The working development versions are at https://github.com/lmhale99/atomman <https://github.com/lmhale99/atomman>__.

Documentation

Web-based documentation for the atomman package is available at https://www.ctcms.nist.gov/potentials/atomman <https://www.ctcms.nist.gov/potentials/atomman>__.

Source code for the documentation can be found in the github doc directory <https://github.com/usnistgov/atomman/tree/master/doc/>__. The doc directory contains the information both as the source RestructuredText files and as unformatted HTML. If you download a copy, you can view the HTML version offline by

cd {atomman_path}/doc/html
python -m http.server

Then, opening localhost:8000 in a web browser.

The documentation consists of two main components:

• Tutorial Jupyter Notebooks: Online html version <https://www.ctcms.nist.gov/potentials/atomman/tutorial/index.html>, Downloadable Notebook version <https://github.com/usnistgov/atomman/tree/master/doc/tutorial>. The tutorials starting with ##. provide a general overview/example of the various capabilities. The tutorials starting with ##.#. give more detailed descriptions and list options available to the tools mentioned in the overview tutorials.

• Code Documentation: Online html version <https://www.ctcms.nist.gov/potentials/atomman/atomman.html>__. This provides a rendering of the Python docstrings for the included functions and classes.

Optional packages

This is a list of additional Python packages that are needed for some of the optional features of the package.

• diffpy.Structure <http://www.diffpy.org/diffpy.Structure/>__: CIF reader. Required for loading systems from CIF files.

• ase <https://wiki.fysik.dtu.dk/ase/>__: The Atomic Simulation Environment for interacting with small systems and DFT calculations. Required for converting to/from ase.Atoms objects.

• pymatgen <http://pymatgen.org/>__: The Python Materials Genomics package used by the Materials Project for DFT calculations. Required for converting to/from pymatgen.Structure objects.

• spglib <https://atztogo.github.io/spglib/python-spglib.html>__: A Python interface to the spglib spacegroup analysis code. spglib can be used to analyze and determine the spacegroup for an atomic system. Required for converting to/from spglib.cell objects.