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

Unclear documentation for SurvivalProbability function #4247

Closed
jaclark5 opened this issue Aug 16, 2023 · 0 comments · Fixed by #4248
Closed

Unclear documentation for SurvivalProbability function #4247

jaclark5 opened this issue Aug 16, 2023 · 0 comments · Fixed by #4248

Comments

@jaclark5
Copy link
Contributor

Expected behavior

The survival probability is the number of particles that have been continuously (or intermittently) in a group for a period of time $\tau$ divided by the number of particles in the group and the beginning of time window. This correlation is averaged over the number of time windows analyzed.

Actual behavior

The existing documentation explains the SurvivalProbabilty function as being divided by the length of the simulation, implying units of inverse time.

Code to reproduce the behavior

NA

Current version of MDAnalysis

  • Which version are you using? (run python -c "import MDAnalysis as mda; print(mda.__version__)"): 2.6.0
  • Which version of Python (python -V)? 3.9.16
  • Which operating system? MacOS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant