Parallel Lammps Python interface - control a mpi4py parallel LAMMPS instance from a serial python process or a Jupyter notebook
Project description
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.lammps
interface 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 leveragingmpi4py
parallel LAMMPS instances.pylammpsmpi.LammpsConcurrent
: Inspired by theconcurrent.futures
module in the standard python library thepylammpsmpi.LammpsConcurrent
interface implements the same API as thepylammpsmpi.LammpsBase
class but rather than holding the controlling process until thempi4py
parallel LAMMPS instance finishes the execution of a given set of commands, thepylammpsmpi.LammpsConcurrent
interface returns aconcurrent.futures.Future
object. This enables the development of asynchronous / concurrent workflows.pylammpsmpi.LammpsLibrary
: Finally, thepylammpsmpi.LammpsLibrary
interface adds a higher level interface on top of the defaultlammps.lammps
interface. 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},
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pylammpsmpi-0.2.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ce60cc2ffc0ca30c5730b13606262233d974c75f66c5ae10a7cf2f87735e2a0 |
|
MD5 | ce04156c9946ce17646ef12d5f18914d |
|
BLAKE2b-256 | ad805291cb5b1c25a2feced3d53d061c71677b843f0087d68b948791f0ed618d |