pylammpsmpi - Parallel Lammps Python interface
With pylammpsmpi you can control a mpi4py parallel LAMMPS instance from a serial python process or a Jupyter
notebook. Internally pylammpsmpi leverages the executorlib communication interface to connect the serial python
process the user interacts with, with the mpi4py parallel LAMMPS instance. The advantage of separating the mpi4py
parallel LAMMPS instance from the rest of the workflow is that the workflow can be written as serial python code, while
still benefiting from the parallel performance of LAMMPS. Still this comes at the cost of additional data transfer, as
the LAMMPS pointers cannot be transferred this way and the linked data has to be copied instead. So copying large
atomistic structures can decrease the performance of the pylammpsmpi interface in comparison to writing your own fully
mpi4py parallel LAMMPS workflows.
Interfaces
The pylammpsmpi module implements three different interfaces for different use cases:
pylammpsmpi.LammpsBase: The most basic interface is theLammpsBase, it implements the same commands like the defaultlammps.lammpsinterface and returns the same datatypes. With this API compatibility to the standard interface, this interface is commonly the easiest way to accelerate a serial LAMMPS based workflow by leveragingmpi4pyparallel LAMMPS instances.pylammpsmpi.LammpsConcurrent: Inspired by theconcurrent.futuresmodule in the standard python library thepylammpsmpi.LammpsConcurrentinterface implements the same API as thepylammpsmpi.LammpsBaseclass but rather than holding the controlling process until thempi4pyparallel LAMMPS instance finishes the execution of a given set of commands, thepylammpsmpi.LammpsConcurrentinterface returns aconcurrent.futures.Futureobject. This enables the development of asynchronous / concurrent workflows.pylammpsmpi.LammpsLibrary: Finally, thepylammpsmpi.LammpsLibraryinterface adds a higher level interface on top of the defaultlammps.lammpsinterface. This higher level interface provides direct access to the commands and thermodynamic properties used in the LAMMPS input files. Especially for experienced LAMMPS users who are familiar with the LAMMPS input files this interface simplifies switching from file based input to using the python interface.
The choice of interface depends on the users background, experience and the simulation protocol the user wants to
implement. Still internally all three interfaces are based on the pylammpsmpi.LammpsConcurrent interface, so they use
an additional thread to connect the mpi4py parallel LAMMPS instance to the serial python process or Jupyter notebook.
Documentation
License
pylammpsmpi is released under the BSD license https://github.com/pyiron/pylammpsmpi/blob/main/LICENSE . It is a
spin-off of the pyiron project https://github.com/pyiron/pyiron therefore if you use pylammpsmpi for calculation
which result in a scientific publication, please cite:
@article{pyiron-paper,
title = {pyiron: An integrated development environment for computational materials science},
journal = {Computational Materials Science},
volume = {163},
pages = {24 - 36},
year = {2019},
issn = {0927-0256},
doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},
url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},
author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and Jörg Neugebauer},
keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},
}
3 maintainers
Metadata
3 maintainers
Release files for pylammpsmpi 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pylammpsmpi-0.5.2.tar.gz | 22.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pylammpsmpi-0.5.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 47.9 kB
Release files / pylammpsmpi-0.5.2.tar.gz
| Download URL | pylammpsmpi-0.5.2.tar.gz |
|---|---|
| Size | 22.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8e74a0609c5b31ff0ed514ba1324b64447d2351ae9bd32e652d68f7fc203601c
|
|
BLAKE2b-256 checksum How to use checksums |
3fb5de9312879aef6bd56febda59b8140114efbacf21fc160c6c1cfc02586406
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.
Transparency logRelease files / pylammpsmpi-0.5.2-py3-none-any.whl
| Download URL | pylammpsmpi-0.5.2-py3-none-any.whl |
|---|---|
| Size | 26.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
92b3c4a12701374304506d66c72f945e527d85fb91ec9524c6433077c1c926d9
|
|
BLAKE2b-256 checksum How to use checksums |
747576c4665d326297ec984ea95d80fe2ed4837effe76f5d67496af4ff6645b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.
Transparency log
