Now each estimator gets its own page.

This allows us to expand on how each estimator works in concept/theory. Wanted to start with space for this so it's easier to add later.
alchemistry · May 22, 2017 · 53a8df0 · 53a8df0
1 parent 6dd8eb5
commit 53a8df0
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 15 deletions.
diff --git a/docs/estimators-fep.rst b/docs/estimators-fep.rst
@@ -68,13 +68,12 @@ In addition to the free energy differences, we also have access to the errors on
     1.00  0.020879  0.015143  0.009983  0.005133  0.000000
 
 
-.. _estimators_MBAR:
+List of FEP-based estimators
+----------------------------
 
-MBAR
-----
-The :class:`~alchemlyb.estimators.MBAR` estimator is a light wrapper around the reference implementation of MBAR from :mod:`pymbar` (:class:`pymbar.mbar.MBAR`).
-As a generalization of BAR, it uses information from all sampled states to generate an estimate for the free energy difference between each state.
+.. currentmodule:: alchemlyb.estimators
 
-.. autoclass:: alchemlyb.estimators.MBAR
-    :members:
-    :inherited-members:
+.. autosummary::
+    :toctree: estimators
+
+    MBAR
diff --git a/docs/estimators-ti.rst b/docs/estimators-ti.rst
@@ -67,12 +67,12 @@ In addition to the free energy differences, we also have access to the errors on
     1.00  0.016362  0.013172  0.009858  0.006447  0.000000
 
 
-.. _estimatators_TI:
+List of TI-based estimators
+---------------------------
 
-TI
---
-The :class:`~alchemlyb.estimators.TI` estimator is a simple implementation of `thermodynamic integration <https://en.wikipedia.org/wiki/Thermodynamic_integration>`_ that uses the trapezoid rule for integrating the space between :math:`\left<\frac{dH}{d\lambda}\right>` values for each :math:`\lambda` sampled.
+.. currentmodule:: alchemlyb.estimators
 
-.. autoclass:: alchemlyb.estimators.TI
-    :members:
-    :inherited-members:
+.. autosummary::
+    :toctree: estimators
+
+    TI
diff --git a/docs/estimators/alchemlyb.estimators.MBAR.rst b/docs/estimators/alchemlyb.estimators.MBAR.rst
@@ -0,0 +1,12 @@
+.. _estimators_MBAR:
+
+MBAR
+====
+The :class:`~alchemlyb.estimators.MBAR` estimator is a light wrapper around the reference implementation of MBAR from :mod:`pymbar` (:class:`pymbar.mbar.MBAR`).
+As a generalization of BAR, it uses information from all sampled states to generate an estimate for the free energy difference between each state.
+
+API Reference
+-------------
+.. autoclass:: alchemlyb.estimators.MBAR
+    :members:
+    :inherited-members:
diff --git a/docs/estimators/alchemlyb.estimators.TI.rst b/docs/estimators/alchemlyb.estimators.TI.rst
@@ -0,0 +1,11 @@
+.. _estimatators_TI:
+
+TI
+==
+The :class:`~alchemlyb.estimators.TI` estimator is a simple implementation of `thermodynamic integration <https://en.wikipedia.org/wiki/Thermodynamic_integration>`_ that uses the trapezoid rule for integrating the space between :math:`\left<\frac{dH}{d\lambda}\right>` values for each :math:`\lambda` sampled.
+
+API Reference
+-------------
+.. autoclass:: alchemlyb.estimators.TI
+    :members:
+    :inherited-members: