atomman 1.1.2

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:

1. Allows for efficient and fast calculations on millions of atoms, each with many freely defined per-atom properties.
2. Create dislocation monopoles and evaluate them with differential displacement and Nye tensor plots.
3. Generate point defects.
4. Call LAMMPS directly from Python and instantly retrieve the resulting data or LAMMPS error statement.
5. Easily convert systems to/from the other Python atomic environments of ASE and PyMatGen.
6. Can create systems based on CIF crystal structure files, and LAMMPS atom and dump files.
7. Built-in unit conversions.

Installation

The atomman package is designed for Python 2.7. It makes heavy use of numpy, so it’s easiest to download a Python environment like Anaconda.

The latest release can be installed using pip:

pip install atomman

This pip command should install atomman and any other required packages, but occasionally a requirement may have to be installed separately. The list of required packages are given below.

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

• The stable releases are available at https://github.com/usnistgov/atomman.
• The working development versions are at https://github.com/lmhale99/atomman.

Documentation

Tutorials and full reference documentation can be found on GitHub in the form of Jupyter Notebooks. This provides explanations as well as examples of functioning code. They can also be downloaded and used interactively.

The links below are to the tutorials for the most recent stable release:

• Introduction to atomman
• Interacting with LAMMPS

Required packages

This is a list of the required Python packages

• xmltodict converts XML files to Python dictionaries. Used by DataModelDict.
• DataModelDict class allowing for easy transformations between XML/JSON/Python representations of structured data models.
• numericalunits forms the basis for unit conversions.
• numpy, scipy, pandas_, and matplotlib Python scientific tools for representing, manipulating and plotting data.

Optional packages

This is a list of additional Python packages that can add functionality

• diffpy.Structure - CIF reader. Required for loading systems from CIF files.
• ase the Atomic Simulation Environment for interacting with small systems and DFT calculations. Required for converting to/from ase.Atoms objects.
• pymatgen the Python Materials Genomics package used by the Materials Project for DFT calculations. Required for converting to/from pymatgen.Structure objects.