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.2.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.2-py3-none-any.whl (123.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: infretis-2025.2.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.2.tar.gz
Algorithm Hash digest
SHA256 8b19ee6b5a35d719e3a8b68ff317a2b140f1bf37fb4de5052b9cef2cf5d244fa
MD5 7e864f32ff811faf72077a11f8a3566b
BLAKE2b-256 9fcb36505e4744d9fbfd56745200a86abf132dd9357baa7ef4008d45e733fda9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: infretis-2025.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 076469ea30eecc32049157a8fa878c78a1e84fa617245c064fc6065742b98495
MD5 83723d27b7cf704d4eeaee8f1c5cc747
BLAKE2b-256 95f1b157f0c82b207e3c0fe25c32cdadafeb5dbc580573b8352001bda4ea61e0

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