Skip to main content

Infinite swapping parallel RETIS

Project description

∞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, ASE, 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

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

infretis-2025.4.tar.gz (109.1 kB view details)

Uploaded Source

Built Distribution

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

infretis-2025.4-py3-none-any.whl (123.4 kB view details)

Uploaded Python 3

File details

Details for the file infretis-2025.4.tar.gz.

File metadata

  • Download URL: infretis-2025.4.tar.gz
  • Upload date:
  • Size: 109.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for infretis-2025.4.tar.gz
Algorithm Hash digest
SHA256 892d3223d173d5bcb36286e541f8af9575615238b2a13f793b5e41cc7b9bdeb4
MD5 4ff49e145924e1e8830da16ec4c9ade6
BLAKE2b-256 d49ac53dc5e0545208226cc917593f30d5c0bf8fd8c29934597e01dcbbde5710

See more details on using hashes here.

File details

Details for the file infretis-2025.4-py3-none-any.whl.

File metadata

  • Download URL: infretis-2025.4-py3-none-any.whl
  • Upload date:
  • Size: 123.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for infretis-2025.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fbda4bc263a31852587ae8b349db3d7a03cf97d63c841916fabce077b399aa95
MD5 533d4a94dd1d5a134023cb2a21deb1f5
BLAKE2b-256 c913b807fd902eac2bfb56a55e0555bf8081b183112ee8fafc89a0ca42cd4345

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