Skip to main content

the simple alchemistry library

Project description

alchemlyb: the simple alchemistry library

Zenodo DOI Documentation Build Status Code coverage anaconda package

alchemlyb makes alchemical free energy calculations easier to do by leveraging the full power and flexibility of the PyData stack. It includes:

  1. Parsers for extracting raw data from output files of common molecular dynamics engines such as GROMACS, AMBER, NAMD and other simulation codes.

  2. Subsamplers for obtaining uncorrelated samples from timeseries data (including extracting independent, equilibrated samples Chodera2016 as implemented in the pymbar package).

  3. Estimators for obtaining free energies directly from this data, using best-practices approaches for multistate Bennett acceptance ratio (MBAR) Shirts2008 and BAR (from pymbar) and thermodynamic integration (TI).

Documentation

The documentation is hosted on Read the Docs.

Installation

Install via pip from PyPi (alchemlyb):

pip install alchemlyb

or as a conda package from the conda-forge (alchemlyb) channel:

conda install -c conda-forge alchemlyb

Update with pip:

pip install --update alchemlyb

or with conda run:

conda update -c conda-forge alchemlyb

to get the latest released version.

Getting involved

Contributions of all kinds are very welcome.

If you have questions or want to discuss alchemlyb please post in the alchemlyb Discussions.

If you have bug reports or feature requests then please get in touch with us through the Issue Tracker.

We also welcome code contributions: have a look at our Developer Guide. Open an issue with the proposed fix or change in the Issue Tracker and submit a pull request against the alchemistry/alchemlyb GitHub repository.

References

  • Shirts, M.R., and Chodera, J.D. (2008). Statistically optimal analysis of samples from multiple equilibrium states. The Journal of Chemical Physics 129, 124105.
  • Chodera, J.D. (2016). A Simple Method for Automated Equilibration Detection in Molecular Simulations. Journal of Chemical Theory and Computation 12, 1799–1805.

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

alchemlyb-2.4.1rc1.tar.gz (79.6 kB view details)

Uploaded Source

Built Distribution

alchemlyb-2.4.1rc1-py3-none-any.whl (99.7 kB view details)

Uploaded Python 3

File details

Details for the file alchemlyb-2.4.1rc1.tar.gz.

File metadata

  • Download URL: alchemlyb-2.4.1rc1.tar.gz
  • Upload date:
  • Size: 79.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for alchemlyb-2.4.1rc1.tar.gz
Algorithm Hash digest
SHA256 8f7fc6e39f23343e2af1417bac3aaf62f0d42489c172b7ae8395ce3b68814c9e
MD5 2f4aba9cbea766665e653a4dd818f969
BLAKE2b-256 0572f1f3abeb71e994e81178582eff9ac1f821ca8c83d99663340cd312133048

See more details on using hashes here.

File details

Details for the file alchemlyb-2.4.1rc1-py3-none-any.whl.

File metadata

  • Download URL: alchemlyb-2.4.1rc1-py3-none-any.whl
  • Upload date:
  • Size: 99.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for alchemlyb-2.4.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 aa78774c4ee55c17504556be6e5ae59c9e6020d94168d0a27788e44a93c9000b
MD5 5324a08cf4c99ed050443939a34e1234
BLAKE2b-256 7f29d40067354d26abddf856bece86a5b7c4c7b5d0acafe3317a4d628dbeec92

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page