Overview
alchemlyb makes alchemical free energy calculations easier by building on the PyData stack. It provides parsers for raw data in output files of common molecular dynamics engines including GROMACS, AMBER and NAMD, subsamplers for obtaining uncorrelated and equilibrated samples, and estimators for MBAR, BAR and thermodynamic integration.
The library processes simulation output; it does not run simulations and does not generate the alchemical transformations themselves. Results depend on the parsed engine files, the decorrelation and equilibration choices, and the estimator used, so the settings and per-window convergence should be reported alongside any free energy difference.
LICENSE states the BSD 3-Clause licence and the project is published in the Journal of Open Source Software. The inspected release on the Python package index requires Python 3.11 or newer; the parsers, samplers and estimators can also be installed from conda-forge.
Key Features
- Parsers for GROMACS, AMBER and NAMD output, plus documented parsers for other engines.
- Subsampling of uncorrelated samples and MBAR, BAR and thermodynamic integration estimators.
Use Cases
- Estimate a free energy difference from existing simulation output and check convergence before reporting it.
How to Use
Install the package with pip or from conda-forge, then parse the engine output for each alchemical window, subsample, and apply an estimator. Record the decorrelation and equilibration settings and inspect per-window overlap rather than reporting a single number without diagnostics.
See the official documentation for parsing and estimators: https://alchemlyb.readthedocs.io/en/latest/
Sources and verification
This entry describes capabilities documented by the linked project sources. Catalog edits are not evidence of a successful run, compatibility test or scientific performance evaluation.
Read the editorial and verification policy