Skip to main content

Atomistic Manipulation Toolkit

Project description

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. Built-in tools for generating and analyzing crystalline defects, such as point defects, stacking faults, and dislocations.

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

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

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

  4. 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.

Documentation

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

Source code for the documentation can be found in the github doc directory. 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:

  1. Tutorial Jupyter Notebooks: Online html version, Downloadable Notebook version. 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.

  2. Code Documentation: Online html version. 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: 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.

  • spglib: 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atomman-1.5.1.tar.gz (1.1 MB view details)

Uploaded Source

File details

Details for the file atomman-1.5.1.tar.gz.

File metadata

  • Download URL: atomman-1.5.1.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for atomman-1.5.1.tar.gz
Algorithm Hash digest
SHA256 f809b485da7702128e28d2766ff64c80b1797e936b85f7291450b96a465ef1da
MD5 42e232f9759bb78bbb8fcd2348f41ddb
BLAKE2b-256 3aec46136aab7d6bb98985fa6b5466155d4340b4a9cad7a3ab214fc036d8d063

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page