Skip to content

A python library for replica exchange transition interface sampling with infinite swaps

License

Notifications You must be signed in to change notification settings

infretis/infretis

Repository files navigation

∞RETIS

Tests Coverage Status Code style: black

Introduction

∞RETIS is a Python library designed to facilitate Replica Exchange Transition Interface Sampling (RETIS). ∞RETIS interfaces with molecular dynamics (MD) programs such as GROMACS, LAMMPS, and CP2K, offering researchers an efficient and flexible tool for advanced simulations.

Our recent publication Highly Parallelizable Path Sampling with Minimal Rejections Using Asynchronous Replica Exchange and Infinite Swaps showcases the capabilities of ∞RETIS. We are also in the process of preparing a detailed paper specifically about this software library.

Features

Installation

∞RETIS can be installed via pip:

pip install infretis

🚧👷 The latest development version can be installed with:

python -m pip install git+https://github.com/infretis/infretis.git@main

⚠️ Note: ∞RETIS does not manage the installation of external MD programs. Users are responsible for installing and configuring these programs independently.

Examples

We have provided several examples to help you get started with ∞RETIS:

Citation

If you use ∞RETIS in your research, please cite our paper: Highly Parallelizable Path Sampling with Minimal Rejections Using Asynchronous Replica Exchange and Infinite Swaps

To cite ∞RETIS in your work, please use the following BibTeX entry:

@article{zhang_highly_2024,
	title = {Highly parallelizable path sampling with minimal rejections using asynchronous replica exchange and infinite swaps},
	volume = {121},
	url = {https://www.pnas.org/doi/10.1073/pnas.2318731121},
	doi = {10.1073/pnas.2318731121},
	number = {7},
	journal = {Proceedings of the National Academy of Sciences},
	author = {Zhang, Daniel T. and Baldauf, Lukas and Roet, Sander and Lervik, Anders and van Erp, Titus S.},
	year = {2024},
	publisher = {Proceedings of the National Academy of Sciences},
}

License

∞RETIS is licensed under the MIT License. Please see the file LICENSE

About

A python library for replica exchange transition interface sampling with infinite swaps

Resources

License

Stars

Watchers

Forks

Packages

No packages published