msmbuilder.tpt.find_path_bottleneck

msmbuilder.tpt.find_path_bottleneck(path, net_flux)

Simply finds the bottleneck along a path.

This is the point at which the cost function first goes up along the path, backtracking from B to A.

Parameters:

path : list

a list of nodes along the path of interest

net_flux : matrix

the net flux matrix

Returns:

bottleneck : tuple

a tuple of the nodes on either end of the bottleneck

flux : float

the flux at the bottleneck

See also

find_top_paths

child function find_top_paths is probably the function you want to call to find paths through an MSM network. This is a utility function called by find_top_paths, but may be useful in some specific cases