Skip to content

Commit

Permalink
Merge pull request #150 from mrshirts/effectiveNupdate
Browse files Browse the repository at this point in the history
Updating the documentation for effective sample number
  • Loading branch information
kyleabeauchamp committed Jan 8, 2015
2 parents c6f3091 + a6ef5cf commit 3f978a4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions pymbar/mbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,12 +313,13 @@ def computeEffectiveSampleNumber(self, verbose = False):
It also counts the efficiency of the sampling, which is simply the ratio
of the effective number of samples at a given state to the total number
of samples collected.
of samples collected. This is printed in verbose output, but is not
returned for now.
Returns
-------
N_eff : np.ndarray, float, shape=(K)
estimated number of states contributing to estimates at each
estimated number of samples contributing to estimates at each
state i. An estimate to how many samples collected just at state
i would result in similar statistical efficiency as the MBAR
simulation. Valid for both sampled states (in which the weight
Expand Down

0 comments on commit 3f978a4

Please sign in to comment.