Skip to content

Unclear documentation for SurvivalProbability function #4247

@jaclark5

Description

@jaclark5

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions