Skip to main content

MC Bond Exchange for LAMMPS Simulations

Project description

MC-Exchange Python Package

The MC-Exchange Python package has been developed to support the dynamic bond exchange reactions (BERs) during a molecular dynamics (MD) simulation run using LAMMPS (Large-scale Atomic/Molecular Massively Parallel Simulator) software. Using the LAMMPS Python package, a MD simulation can be run directly from a Python script, allowing an interface between Python and LAMMPS. The MC-Exchange Python package uses this to gather the necessary data from the LAMMPS MD simulation, analyze the data, determine which bonds to exchanged, and finally communicate the altered bond data back to LAMMPS, where the actual bond exchange can take place.

The package is written with the ease of use in mind. However, users must be warned that a thorough understanding of the LAMMPS Python package is necessary to be able to gather the necessary bits of data prior to performing bond exchange reactions using the MC-Exchange Python library.

General Use

To install the package, users are asked to clone the repository. Once at the root level of the repository, the distribution files can be generated, and subsequently the package can be installed as follows:

macOS / Linux Instructions
python3 -m pip install --upgrade build
python3 -m build
pip install 
Windows Instructions
py -m pip install --upgrade build
py -m build

After successful installation of the MC-Exchange Python package, it can be imported into a script as follows:

import MC_exchange as mc

The above statement imports all functionalities of the package.

Package organization

The MC-Exchange Python package is organized into modules. Currently, there are three modules dedicated to the base functionalities, and one module where these functionalities are combined to perform bond exchange reactions. The three base modules are calculations.py, data.py and neigh_list.py.

Base modules

Currently, three base modules are responsible for the primary functionalities of the package. data.py is the module responsible for gathering data from the LAMMPS simulations. calculations.py contains calculations that use the data obtained by the functions of data.py to compute properties that can be necessary during bond exchange reactions. Lastly, neigh_list.py contain the functionalities required to construct spacial neighbor lists using atom data.

Functionalities

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

mc_exchange-1.0.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mc_exchange-1.0.0-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file mc_exchange-1.0.0.tar.gz.

File metadata

  • Download URL: mc_exchange-1.0.0.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for mc_exchange-1.0.0.tar.gz
Algorithm Hash digest
SHA256 431d8f3b6c21d9e23fe9c337156368453813dbac13e5c50bf60c03a8f83dabf9
MD5 04a4c57c7753a37d0d6369f90f10854d
BLAKE2b-256 13362903a2cd2cf38a8cd7fc08a7cd3582106096803f370447812a37c7c437dc

See more details on using hashes here.

File details

Details for the file mc_exchange-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mc_exchange-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for mc_exchange-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac83bb5212b9c3529546e5a16867a8fba404b20393ce02f4ce9c8bbc4af73cd1
MD5 a3fe2cee8cd8a9ff3e65db230ed3bd7a
BLAKE2b-256 302bd30b809fe489f89cd398e3ddfb9947b5327abbe69936bf817e1cf6c9e800

See more details on using hashes here.

Supported by

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