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-2026.1.1.tar.gz (109.8 kB view details)

Uploaded Source

Built Distribution

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

infretis-2026.1.1-py3-none-any.whl (124.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: infretis-2026.1.1.tar.gz
  • Upload date:
  • Size: 109.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for infretis-2026.1.1.tar.gz
Algorithm Hash digest
SHA256 e7723ddd213b4ce37561003c3c87a8d02dbd02095aeb68fc7347e097d650583e
MD5 828f25cb4ae1935805cf694451f944b4
BLAKE2b-256 6118d0a4df78af4a4b5602649de316b5232e0075482da53422efd57eeb2a8814

See more details on using hashes here.

File details

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

File metadata

  • Download URL: infretis-2026.1.1-py3-none-any.whl
  • Upload date:
  • Size: 124.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for infretis-2026.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e6562c1aa07b34292306ea3083c204058c4affd12ad2d124aec7ce81bc1883f
MD5 b5ce5172ae78d48db38dd83ed112b117
BLAKE2b-256 d131ce91fcc59ef3aa73e3a3e9d2b3011dd8d18e3c2f44422a48d3dd02d88e94

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