Becksteinlab / kda

Python package used for the analysis of biochemical kinetic diagrams.
GNU General Public License v3.0
3 stars 1 forks source link

Update CCW - CW explanations in functions #16

Closed nawtrey closed 3 months ago

nawtrey commented 4 years ago

The convention chosen for calculating pi differences and thermodynamic forces is CCW - CW, but the way they are explained in the documentation is not quite clear about why this is. This needs to be updated so it is clear what is going on and why.

nawtrey commented 3 months ago

Looking at this now --

It looks like there are a couple things to mention:

  1. The equations need to be put into the documentation somewhere. Some of our functions are actually named after components of the equations, so it would be useful to know the context.
  2. We need to clarify (somewhere, at least in calc_net_cycle_flux()) that cycles must be chosen in a consistent manner. Probably just take some text right out of the KDA manuscript

Here is a list of functions that need to be gone through (from kda.calculations):

~It might be good to handle #65 at the same time.~

nawtrey commented 3 months ago

Addressed in GH-92. Closing.