/host-guest-benchmarks

Host-guest structures for binding free energy benchmarks

Primary LanguagePythonMIT LicenseMIT

Taproom

A repository of host-guest complexes available for benchmarking force fields used in the OpenFF-Evaluator program.

US Patent 664824

Host-Guest Complexes

Taproom includes the following host-guest complexes (126 in total) with YAML files containing information necessary to perform free energy calculation using the attach-pull-release (APR) method.

Installation

This module is designed to be lightweight and have minimal dependencies. As such, the simplest way to use these benchmarks is to clone this repository and run python setup.py develop. After installation, taproom.benchmarks is exposed as an entry point, and available to other Python modules. The dictionary host_guest_systems contains YAML-formatted "instructions" that can be used to simulate the host-guest complexes. The dictionary host_guest_measurements contains YAML-formatted experimental data, curated from public literature.

The following snippet can be used to expose the installed benchmarks.

import importlib.metadata

def _get_installed_benchmarks():
    _installed_benchmarks = {}

    for entry_point in importlib.metadata.entry_points(group="taproom.benchmarks"):
        _installed_benchmarks[entry_point.name] = entry_point.load()

    return _installed_benchmarks

host_guest_benchmarks = _get_installed_benchmarks()
host_guest_systems = host_guest_benchmarks["host_guest_systems"]
host_guest_measurements = host_guest_benchmarks["host_guest_measurements"]

Schema

For information on the YAML formatting, see Schema.md.

License

MIT. See License for more information.

Copyright

Copyright (c) 2023, Open Force Field Consortium

Contributors

  • David R. Slochower
  • Simon Boothroyd
  • Katy Kellett
  • Jeffry Setiadi