Skip to main content

Asynchronous Replica Exchange with OpenMM

Project description

AToM-OpenMM v8.5

AToM logo

The Alchemical Transfer Method for OpenMM (AToM-OpenMM) is an extensible Python package for the estimation of absolute and relative binding free energies of molecular complexes. It implements the Alchemical Transfer Method (ATM) with asynchronous parallel replica exchange molecular dynamics with the OpenMM library. The AToM software can be deployed on workstations or cluster nodes with one or more GPUs.

This version of AToM-OpenMM has been tested with OpenMM 8.5 and 8.4; it uses ATMForce in the 8.4.0 or later versions of OpenMM.

Credits

This software is developed and maintained by the Emilio Gallicchio's lab with support from current and past grants from the National Science Foundation (ACI 1440665 and CHE 1750511) and the National Institutes of Health (R15 GM151708).

Maintainer/Author:

Contributors:

  • Elian Tiudic
  • Sylvester Sakyi
  • Stefan Doerr
  • Sheenam Khuttan
  • Joe Z Wu
  • Solmaz Azimi
  • Baofeng Zhang
  • Rajat Pal

The asynchronous replica exchange method was first implemented in the AsyncRE package for the IMPACT program.

Bibliography

Please cite us if you use this software in your research:

Installation & Usage

It is recommended that the installation is performed in a personal Python environment (miniforge, miniconda, conda, or similar). AToM-OpenMM requires the openmm and other Python modules.

This version of AToM-OpenMM requires OpenMM 8.4.0 or later. This conda command installs the necessary requirements:

mamba create -n atm8.5.0 -c conda-forge 'openmm>=8.4' ambertools openmmforcefields configobj setproctitle r-base espaloma
mamba activate atm8.5.0

setproctitle above is optional but useful to track the names of the processes started by AToM-OpenMM. The ambertools, openmmforcefields, and espaloma packages are not actual dependencies; they are used to prepare the molecular systems. openmmforcefields, in particular, is used to assign force field parameters using OpenFF, GAFF, or espaloma. espaloma is a machine-learning system by the Chodera lab to assign force field parameters. The r-base dependency with the UWHAM R package (see below) is required for free energy estimation in legacy workflows and will be removed in later versions. See examples for examples and tutorials.

Finally, install AToM-OpenMM:

  • From the latest release:
pip install atom-openmm
  • From the latest sources:
git clone https://github.com/Gallicchio-Lab/AToM-OpenMM.git
cd AToM-OpenMM
pip install .

And this will install the UWHAM R package:

Rscript -e 'install.packages("UWHAM", repos = "http://cran.us.r-project.org")' 

While we strive to develop and distribute high-quality and bug-free software, keep in mind that this is research software under heavy development. AToM-OpenMM is provided without any guarantees of correctness. Please report issues here. We welcome contributions and pull requests.

Documentation

AToM-OpenMM User Guide

AToM-OpenMM Theory Introduction

See examples for examples, workflows, and tutorials.

See example-notebooks for example Notebooks.

Licensing

This software is licensed under the terms of the GNU Lesser General Public License. See LICENSE. The AToM logo © 2023 Solmaz Azimi.

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

atom_openmm-8.5.0b0.tar.gz (25.4 MB view details)

Uploaded Source

File details

Details for the file atom_openmm-8.5.0b0.tar.gz.

File metadata

  • Download URL: atom_openmm-8.5.0b0.tar.gz
  • Upload date:
  • Size: 25.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for atom_openmm-8.5.0b0.tar.gz
Algorithm Hash digest
SHA256 e3812db1ce3b0546adce00960f2a9b3d2ae051503b550cae84df7f278ccf04b8
MD5 0db3a5e4c0bc7da3dbef7eb9b21a2c03
BLAKE2b-256 dfc0268c3358f296dfc4b58c9e719de1802c624fc99f0b6878b8bcf627cb4941

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