Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify docs #353

Merged
merged 6 commits into from
May 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/estimators-fep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,13 @@ The :meth:`~alchemlyb.estimators.MBAR.fit` method is used to perform the free en
>>> mbar_vdw = MBAR().fit(u_nk_vdw)

The sum of the endpoint free energy differences will be the free energy of solvation for benzene in water.
The free energy differences (in units of :math:`k_B T`) between each :math:`\lambda` window can be accessed via the ``delta_f_`` attribute::
The free energy differences (in units of :math:`k_B T`) between each :math:`\lambda` window can be accessed via the ``delta_f_`` attribute.

The elements of the resulting matrix ``delta_f_`` represent the free energy differences between different lambda windows. Specifically, ``delta_f_[i, j]`` represents the free energy difference between lambda window ``j`` and lambda window ``i``. This matrix can be utilized to obtain the desired free energy differences for various states.

For instance, to obtain the free energy difference between the lambda values of 0 and 1, you can directly access ``delta_f_.loc[0.00, 1.00]``.

Additionally, the errors on these differences are accessible via the ``d_delta_f_`` attribute.

>>> mbar_coul.delta_f_
0.00 0.25 0.50 0.75 1.00
Expand Down
Loading