Skip to main content

A package to find optimal state free energies from a thermodynamic graph.

Project description

Multibind

DOI Tests codecov docs

Thermodynamic cycles which are defined by a set of individually determined free energy differences are not guaranteed to be thermodynamically consistent. This criterion is only satisfied when all the differences in a closed loop vanish. Multibind is a Python package that allows for the combination of these differences, along with their variances, into a set of data-informed and thermodynamically consistent state free energies. Additionally, multibind supports cycles whose free energies are dependent on multiple ligand concentrations.

Installation

multibind is on PyPI. Python 3.10 through 3.14 is supported.

pip install multibind

Using conda or mamba, create an environment with a suitable Python version, then run the same command inside it.

To work from a Git clone (editable install), run tests, build docs, or use Poetry, see INSTALL.md.

State definitions

States are minimally defined by a name and should be added to a csv file. Macrostate classes can be added as additional columns with the name of the class being the column header.

name,n_protons,n_sodium
1,0,0
2,0,1
3,1,0
4,1,1

Graph definition

States are not enough to define the graph, you'll need edges. These edges are the free energy differences between states and are characterized by a specific type of process.

Multibind allows for three process type, which are specified under the ligand column:

  • "H+": proton binding which takes as its free energy value, the pKa.
  • general ligand: binding of a general ligand. The standard state free energy in kT. By defining the concentration to build the cycle, this free energy becomes concentration dependent.
  • "helm": undefined process which takes a free energy directly in kT.

In defining the edges, always treat the free energies as going from state 1 to state 2 for that process. For 'H+', state 1 should be the deprotonated state and state 2 is the protonated state. For a general ligand, state 1 is the unbound state and state 2 is the bound state. Failure to do so will assign the negative of the desired free energy to that edge.

# graph.csv
state1,state2,value,variance,ligand,standard_state
1,2,-10,0.1,Na+,1
2,3,5.697116,0.1,H+,1
4,3,-6,0.1,Na+,1
1,4,7.434294,0.1,H+,1

Example code

The standard Multibind object is used to solve the graph at one point in concentration space.

import multibind as mb

concentrations = {'Na': 0.150}

c = mb.Multibind()
c.read_graph("examples/input/4-state-diamond/graph.csv",comment="#")
c.read_states("examples/input/4-state-diamond/states.csv")
c.concentrations = concentrations
c.build_cycle(pH=7)
c.MLE(svd=True) 
# compute the effective energy difference between two macrostates
# if you are unsure of the values to pass to the function, look
# at either your state file or the contents of c.states
c.effective_energy_difference("N_protons",1,2)

The MultibindScanner can be used to scan across a bunch of concentrations.

import multibind as mb

state_file = 'examples/input/4-state-diamond/states.csv'
graph_file = 'examples/input/4-state-diamond/graph.csv'

scanner = mb.MultibindScanner(state_file, graph_file, comment_char='#')

concentrations = {'H+': [7, 8, 9], 'Na+': [0.200, 0.150, 0.100]}
# This will MLE calculations across 9 points in concentration space
# the results will be in an xarray Dataset that can be accessed with
# scanner.results
scanner.run(concentrations, svd=True)

Citation

When using multibind in published works, please cite the following preprint:

Kenney, Ian Michael, and Oliver Beckstein. Thermodynamically Consistent Determination of Free Energies and Rates in Kinetic Cycle Models. Biophysical Reports 3 (2023), 100120. doi:10.1016/j.bpr.2023.100120.

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

multibind-0.2.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

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

multibind-0.2.1-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file multibind-0.2.1.tar.gz.

File metadata

  • Download URL: multibind-0.2.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for multibind-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ed89f5e54bf742ae7b2bdf5df9f4faab0eaad6d0b13972ec5dd98d0e3ab74627
MD5 71ec4afc6f8348634a6f5dcad416ee21
BLAKE2b-256 35375951af0af82f23b920a53fab5e494c2d34aef5c672209d9095ed9b7b4abd

See more details on using hashes here.

Provenance

The following attestation bundles were made for multibind-0.2.1.tar.gz:

Publisher: deploy.yaml on Becksteinlab/multibind

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file multibind-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: multibind-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for multibind-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e2fd080a3bc9d874242f29ef4e0200cf3a75a3228b37bc66b1e9192421737aa
MD5 5a25ce827292bf13e9922b9f1bfd0e76
BLAKE2b-256 7f28ba12976f93c1bd404a6f2c98d349b74d7a62a6a5e14c54a577c49bb75e4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for multibind-0.2.1-py3-none-any.whl:

Publisher: deploy.yaml on Becksteinlab/multibind

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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