#!/usr/bin/env python
# coding: utf-8

# ## A cycle of reactions `A <-> B <-> C <-> A`
# #### the "closing" of the above cycle (the "return" parth from `C` to `A`) is coupled with an "energy donor" reaction:
# #### `C + E_High <-> A + E_Low`
# #### where `E_High` and `E_Low` are, respectively, the high- and low- energy molecules that drive the cycle (for example, think of ATP/ADP).   
# Comparisons are made between results obtained with 3 different time resolutions.
# 
# All 1st-order kinetics.    
# 
# LAST REVISED: May 24, 2023

# In[1]:


import set_path      # Importing this module will add the project's home directory to sys.path


# In[2]:


from experiments.get_notebook_info import get_notebook_basename

from src.modules.reactions.reaction_data import ReactionData as chem
from src.modules.reactions.reaction_dynamics import ReactionDynamics
from src.modules.numerical.numerical import Numerical as num

import numpy as np
import plotly.express as px
from src.modules.visualization.graphic_log import GraphicLog


# In[3]:


# Initialize the HTML logging
log_file = get_notebook_basename() + ".log.htm"    # Use the notebook base filename for the log file

# Set up the use of some specified graphic (Vue) components
GraphicLog.config(filename=log_file,
                  components=["vue_cytoscape_1"],
                  extra_js="https://cdnjs.cloudflare.com/ajax/libs/cytoscape/3.21.2/cytoscape.umd.js")


# ### Initialize the system

# In[4]:


# Initialize the system
chem_data = chem(names=["A", "B", "C", "E_high", "E_low"])

# Reaction A <-> B, mostly in forward direction (favored energetically)
# Note: all reactions in this experiment have 1st-order kinetics for all species
chem_data.add_reaction(reactants="A", products="B",
                       forward_rate=9., reverse_rate=3.)

# Reaction B <-> C, also favored energetically
chem_data.add_reaction(reactants="B", products="C",
                       forward_rate=8., reverse_rate=4.)

# Reaction C + E_High <-> A + E_Low, also favored energetically, but kinetically slow
# Note that, thanks to the energy donation from E, we can go "upstream" from C, to the higher-energy level of "A"
chem_data.add_reaction(reactants=["C" , "E_high"], products=["A", "E_low"],
                       forward_rate=1., reverse_rate=0.2)

chem_data.describe_reactions()

# Send the plot of the reaction network to the HTML log file
graph_data = chem_data.prepare_graph_network()
GraphicLog.export_plot(graph_data, "vue_cytoscape_1")


# ### Set the initial concentrations of all the chemicals

# In[5]:


initial_conc = {"A": 100., "B": 0., "C": 0., "E_high": 1000., "E_low": 0.}  # Note the abundant energy source "E_high"
initial_conc


# ### We'll split each simulation in three segments (apparent from the graphs of the runs, further down):  
# Time [0-0.03] fast changes   
# Time [0.03-5.] medium changes   
# Time [5.-8.] slow changes, as we approach equilibrium  
# 
# ### and we'll do MULTIPLE RUNS, at varying time resolutions.

# 

# # Run # 1 : FIXED time resolution, with COARSE time steps   
# (trial and error, not shown, reveals that increasing any of the time steps below, leads to "excessive time step" errors)

# In[6]:


dynamics = ReactionDynamics(reaction_data=chem_data)
dynamics.set_conc(conc=initial_conc, snapshot=True)
dynamics.describe_state()


# In[7]:


dynamics.set_diagnostics()       # To save diagnostic information about the call to single_compartment_react()


# In[8]:


dynamics.single_compartment_react(initial_step=0.0008, target_end_time=0.03)
#dynamics.get_history()


# In[9]:


dynamics.single_compartment_react(initial_step=0.001, target_end_time=5.)
#dynamics.get_history()


# In[10]:


dynamics.single_compartment_react(initial_step=0.005, target_end_time=8.)


# In[11]:


dynamics.get_history()


# ### Notice we created 5,609 data points

# In[12]:


dynamics.explain_time_advance()


# ## Plots of changes of concentration with time

# In[13]:


dynamics.plot_curves(chemicals=["E_high", "E_low"], colors=["red", "grey"])


# In[14]:


dynamics.plot_curves(chemicals=["A", "B", "C"])


# ### The plots has 4 distinctive intersections; locate them and save them for later comparisons across repeated runs:

# In[15]:


run1 = []


# In[16]:


run1.append(dynamics.curve_intersection("E_high", "E_low", t_start=1., t_end=2.))


# In[17]:


run1.append(dynamics.curve_intersection("A", "B", t_start=2.31, t_end=2.33))


# In[18]:


run1.append(dynamics.curve_intersection("A", "C", t_start=3., t_end=4.))


# In[19]:


run1.append(dynamics.curve_intersection("B", "C", t_start=3., t_end=4.))


# In[20]:


run1


# ### Verify the final equilibrium state:

# In[21]:


dynamics.is_in_equilibrium()


# 

# 

# # _NOTE: Everything below is JUST A REPEAT of the same experiment, with different time steps, for accuracy comparisons_

# # Run # 2. VARIABLE time resolution

# In[22]:


dynamics = ReactionDynamics(reaction_data=chem_data)   # Note: OVER-WRITING the "dynamics" object
dynamics.set_conc(conc=initial_conc, snapshot=True) 
dynamics.describe_state()


# In[23]:


dynamics.set_diagnostics()       # To save diagnostic information about the call to single_compartment_react()


# In[24]:


# These settings can be tweaked to make the time resolution finer or coarser
dynamics.set_thresholds(norm="norm_A", low=0.01, high=0.012, abort=0.015)
dynamics.set_thresholds(norm="norm_B", low=0.002, high=0.4, abort=0.5)
dynamics.set_step_factors(upshift=1.6, downshift=0.15, abort=0.05)
dynamics.set_error_step_factor(0.05)

dynamics.single_compartment_react(initial_step=0.0001, target_end_time=8.0,
                                  variable_steps=True, explain_variable_steps=False)


# ### Notice we created 9,499 data points, a fair bit more than in run #1

# In[25]:


# dynamics.get_history()
# dynamics.explain_time_advance()


# In[27]:


dynamics.plot_curves(chemicals=["E_high", "E_low"], colors=["red", "grey"])


# In[26]:


dynamics.plot_curves(chemicals=["A", "B", "C"])


# ### The plots has 4 distinctive intersections; locate and save them:

# In[28]:


run2 = []


# In[29]:


run2.append(dynamics.curve_intersection(t_start=1., t_end=2., chem1="E_high", chem2="E_low"))


# In[30]:


run2.append(dynamics.curve_intersection(t_start=2.31, t_end=2.33, chem1="A", chem2="B"))


# In[31]:


run2.append(dynamics.curve_intersection(t_start=3., t_end=4., chem1="A", chem2="C"))


# In[32]:


run2.append(dynamics.curve_intersection(t_start=3., t_end=4., chem1="B", chem2="C"))


# In[33]:


run2


# In[ ]:





# In[ ]:





# # Run # 3. FIXED time resolution, using the smallest time substeps from run # 2  
# #### (i.e. FINER fixed resolution than in run #1)
# 

# In[34]:


dynamics = ReactionDynamics(reaction_data=chem_data)   # Note: OVER-WRITING the "dynamics" object
dynamics.set_conc(conc=initial_conc, snapshot=True) 
dynamics.describe_state()


# In[35]:


dynamics.set_diagnostics()       # To save diagnostic information about the call to single_compartment_react()


# In[36]:


dynamics.single_compartment_react(initial_step=0.0004, target_end_time=0.03)


# In[37]:


dynamics.single_compartment_react(initial_step=0.0005, target_end_time=5.)


# In[38]:


dynamics.single_compartment_react(initial_step=0.0025, target_end_time=8.)


# In[39]:


dynamics.get_history()


# ### Notice we created 11,217 data points, a fair bit more than in run #2, and a good deal more than in run #1

# In[40]:


dynamics.explain_time_advance()


# ## Plots of changes of concentration with time

# In[41]:


dynamics.plot_curves(chemicals=["E_high", "E_low"], colors=["red", "grey"])


# In[42]:


dynamics.plot_curves(chemicals=["A", "B", "C"])


# ### The plots has 4 distinctive intersections; locate and save them:

# In[43]:


run3 = []


# In[44]:


run3.append(dynamics.curve_intersection(t_start=1., t_end=2., chem1="E_high", chem2="E_low"))


# In[45]:


run3.append(dynamics.curve_intersection(t_start=2.31, t_end=2.33, chem1="A", chem2="B"))


# In[46]:


run3.append(dynamics.curve_intersection(t_start=3., t_end=4., chem1="A", chem2="C"))


# In[47]:


run3.append(dynamics.curve_intersection(t_start=3., t_end=4., chem1="B", chem2="C"))


# In[48]:


run3


# In[ ]:





# # Finally, compare (using a Euclidean metric) the discrepancy between the runs
# Run #3, at high resolution, could be thought of as "the closest to the actual values"

# In[49]:


# Discrepancy of run1 from run3
num.compare_results(run1, run3)


# In[50]:


# Discrepancy of run2 from run3
num.compare_results(run2, run3)


# The fact that our measure of distance of run 2 (with intermediate resolution) from run3 is actually a little GREATER than the distance of run 1 (with low resolution) from run3, might be an artifact of the limited accuracy in the extraction of intersection coordinates from the saved run data.

# #### The coordinates of the 4 critical points, from the 3 different runs, are pretty similar to one another - as can be easily seen:

# In[51]:


run1


# In[52]:


run2


# In[53]:


run3


# In[ ]: