msmtools.flux.total_flux

msmtools.flux.total_flux(F, A=None)
Compute the total flux, or turnover flux, that is produced by
the flux sources and consumed by the flux sinks.
Parameters:
  • F ((M, M) ndarray) – Matrix of flux values between pairs of states.
  • A (array_like (optional)) – List of integer state labels for set A (reactant)
Returns:

F – The total flux, or turnover flux, that is produced by the flux sources and consumed by the flux sinks

Return type:

float

References

[1]P. Metzner, C. Schuette and E. Vanden-Eijnden. Transition Path Theory for Markov Jump Processes. Multiscale Model Simul 7: 1192-1219 (2009)