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.
The working development versions are at https://github.com/lmhale99/atomman.
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:
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.
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.
1 maintainer
Metadata
1 maintainer
Release files for atomman 1.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| atomman-1.5.4.tar.gz | 3.9 MB | Without provenance | Details |
Release files / atomman-1.5.4.tar.gz
| Download URL | atomman-1.5.4.tar.gz |
|---|---|
| Size | 3.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
75b440bd88ed3fa1375fb4a5cfcf7143ddbc8d24f288889da9b3b690607bd811
|
|
BLAKE2b-256 checksum How to use checksums |
7d00aa65849d1ba07248a3d2c0c9b0a31f1014491ee52dfd590ee51817233f27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for atomman 1.5.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
