annotate COBRAxy/flux_simulation_beta.py @ 456:a6e45049c1b9 draft default tip

Uploaded
author francesco_lapi
date Fri, 12 Sep 2025 17:28:45 +0000
parents f49c951c9fe6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
1 """
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
2 Flux sampling and analysis utilities for COBRA models.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
3
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
4 This script supports two modes:
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
5 - Mode 1 (model_and_bounds=True): load a base model and apply bounds from
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
6 separate files before sampling.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
7 - Mode 2 (model_and_bounds=False): load complete models and sample directly.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
8
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
9 Sampling algorithms supported: OPTGP and CBS. Outputs include flux samples
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
10 and optional analyses (pFBA, FVA, sensitivity), saved as tabular files.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
11 """
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
12
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
13 import argparse
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
14 import utils.general_utils as utils
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
15 from typing import List
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
16 import os
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
17 import pandas as pd
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
18 import cobra
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
19 import utils.CBS_backend as CBS_backend
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
20 from joblib import Parallel, delayed, cpu_count
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
21 from cobra.sampling import OptGPSampler
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
22 import sys
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
23 import utils.model_utils as model_utils
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
24
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
25
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
26 ################################# process args ###############################
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
27 def process_args(args :List[str] = None) -> argparse.Namespace:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
28 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
29 Processes command-line arguments.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
30
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
31 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
32 args (list): List of command-line arguments.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
33
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
34 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
35 Namespace: An object containing parsed arguments.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
36 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
37 parser = argparse.ArgumentParser(usage = '%(prog)s [options]',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
38 description = 'process some value\'s')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
39
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
40 parser.add_argument("-mo", "--model_upload", type = str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
41 help = "path to input file with custom rules, if provided")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
42
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
43 parser.add_argument("-mab", "--model_and_bounds", type = str,
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
44 choices = ['True', 'False'],
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
45 required = True,
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
46 help = "upload mode: True for model+bounds, False for complete models")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
47
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
48
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
49 parser.add_argument('-ol', '--out_log',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
50 help = "Output log")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
51
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
52 parser.add_argument('-td', '--tool_dir',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
53 type = str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
54 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
55 help = 'your tool directory')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
56
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
57 parser.add_argument('-in', '--input',
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
58 required = True,
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
59 type=str,
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
60 help = 'input bounds files or complete model files')
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
61
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
62 parser.add_argument('-ni', '--name',
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
63 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
64 type=str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
65 help = 'cell names')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
66
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
67 parser.add_argument('-a', '--algorithm',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
68 type = str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
69 choices = ['OPTGP', 'CBS'],
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
70 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
71 help = 'choose sampling algorithm')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
72
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
73 parser.add_argument('-th', '--thinning',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
74 type = int,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
75 default= 100,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
76 required=False,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
77 help = 'choose thinning')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
78
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
79 parser.add_argument('-ns', '--n_samples',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
80 type = int,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
81 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
82 help = 'choose how many samples')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
83
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
84 parser.add_argument('-sd', '--seed',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
85 type = int,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
86 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
87 help = 'seed')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
88
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
89 parser.add_argument('-nb', '--n_batches',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
90 type = int,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
91 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
92 help = 'choose how many batches')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
93
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
94 parser.add_argument('-opt', '--perc_opt',
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
95 type = float,
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
96 default=0.9,
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
97 required = False,
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
98 help = 'choose the fraction of optimality for FVA (0-1)')
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
99
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
100 parser.add_argument('-ot', '--output_type',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
101 type = str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
102 required = True,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
103 help = 'output type')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
104
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
105 parser.add_argument('-ota', '--output_type_analysis',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
106 type = str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
107 required = False,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
108 help = 'output type analysis')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
109
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
110 parser.add_argument('-idop', '--output_path',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
111 type = str,
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
112 default='flux_simulation',
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
113 help = 'output path for maps')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
114
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
115 ARGS = parser.parse_args(args)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
116 return ARGS
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
117
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
118 ########################### warning ###########################################
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
119 def warning(s :str) -> None:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
120 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
121 Log a warning message to an output log file and print it to the console.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
122
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
123 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
124 s (str): The warning message to be logged and printed.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
125
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
126 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
127 None
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
128 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
129 with open(ARGS.out_log, 'a') as log:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
130 log.write(s + "\n\n")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
131 print(s)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
132
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
133
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
134 def write_to_file(dataset: pd.DataFrame, name: str, keep_index:bool=False)->None:
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
135 """
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
136 Write a DataFrame to a TSV file under ARGS.output_path with a given base name.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
137
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
138 Args:
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
139 dataset: The DataFrame to write.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
140 name: Base file name (without extension).
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
141 keep_index: Whether to keep the DataFrame index in the file.
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
142
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
143 Returns:
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
144 None
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
145 """
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
146 dataset.index.name = 'Reactions'
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
147 dataset.to_csv(ARGS.output_path + "/" + name + ".csv", sep = '\t', index = keep_index)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
148
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
149 ############################ dataset input ####################################
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
150 def read_dataset(data :str, name :str) -> pd.DataFrame:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
151 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
152 Read a dataset from a CSV file and return it as a pandas DataFrame.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
153
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
154 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
155 data (str): Path to the CSV file containing the dataset.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
156 name (str): Name of the dataset, used in error messages.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
157
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
158 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
159 pandas.DataFrame: DataFrame containing the dataset.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
160
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
161 Raises:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
162 pd.errors.EmptyDataError: If the CSV file is empty.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
163 sys.exit: If the CSV file has the wrong format, the execution is aborted.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
164 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
165 try:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
166 dataset = pd.read_csv(data, sep = '\t', header = 0, index_col=0, engine='python')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
167 except pd.errors.EmptyDataError:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
168 sys.exit('Execution aborted: wrong format of ' + name + '\n')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
169 if len(dataset.columns) < 2:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
170 sys.exit('Execution aborted: wrong format of ' + name + '\n')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
171 return dataset
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
172
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
173
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
174
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
175 def OPTGP_sampler(model:cobra.Model, model_name:str, n_samples:int=1000, thinning:int=100, n_batches:int=1, seed:int=0)-> None:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
176 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
177 Samples from the OPTGP (Optimal Global Perturbation) algorithm and saves the results to CSV files.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
178
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
179 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
180 model (cobra.Model): The COBRA model to sample from.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
181 model_name (str): The name of the model, used in naming output files.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
182 n_samples (int, optional): Number of samples per batch. Default is 1000.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
183 thinning (int, optional): Thinning parameter for the sampler. Default is 100.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
184 n_batches (int, optional): Number of batches to run. Default is 1.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
185 seed (int, optional): Random seed for reproducibility. Default is 0.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
186
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
187 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
188 None
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
189 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
190
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
191 for i in range(0, n_batches):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
192 optgp = OptGPSampler(model, thinning, seed)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
193 samples = optgp.sample(n_samples)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
194 samples.to_csv(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_OPTGP.csv', index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
195 seed+=1
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
196 samplesTotal = pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
197 for i in range(0, n_batches):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
198 samples_batch = pd.read_csv(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_OPTGP.csv')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
199 samplesTotal = pd.concat([samplesTotal, samples_batch], ignore_index = True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
200
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
201 write_to_file(samplesTotal.T, model_name, True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
202
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
203 for i in range(0, n_batches):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
204 os.remove(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_OPTGP.csv')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
205
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
206
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
207 def CBS_sampler(model:cobra.Model, model_name:str, n_samples:int=1000, n_batches:int=1, seed:int=0)-> None:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
208 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
209 Samples using the CBS (Constraint-based Sampling) algorithm and saves the results to CSV files.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
210
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
211 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
212 model (cobra.Model): The COBRA model to sample from.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
213 model_name (str): The name of the model, used in naming output files.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
214 n_samples (int, optional): Number of samples per batch. Default is 1000.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
215 n_batches (int, optional): Number of batches to run. Default is 1.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
216 seed (int, optional): Random seed for reproducibility. Default is 0.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
217
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
218 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
219 None
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
220 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
221
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
222 df_FVA = cobra.flux_analysis.flux_variability_analysis(model,fraction_of_optimum=0).round(6)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
223
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
224 df_coefficients = CBS_backend.randomObjectiveFunction(model, n_samples*n_batches, df_FVA, seed=seed)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
225
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
226 for i in range(0, n_batches):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
227 samples = pd.DataFrame(columns =[reaction.id for reaction in model.reactions], index = range(n_samples))
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
228 try:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
229 CBS_backend.randomObjectiveFunctionSampling(model, n_samples, df_coefficients.iloc[:,i*n_samples:(i+1)*n_samples], samples)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
230 except Exception as e:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
231 utils.logWarning(
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
232 "Warning: GLPK solver has failed for " + model_name + ". Trying with COBRA interface. Error:" + str(e),
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
233 ARGS.out_log)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
234 CBS_backend.randomObjectiveFunctionSampling_cobrapy(model, n_samples, df_coefficients.iloc[:,i*n_samples:(i+1)*n_samples],
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
235 samples)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
236 utils.logWarning(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_CBS.csv', ARGS.out_log)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
237 samples.to_csv(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_CBS.csv', index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
238
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
239 samplesTotal = pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
240 for i in range(0, n_batches):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
241 samples_batch = pd.read_csv(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_CBS.csv')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
242 samplesTotal = pd.concat([samplesTotal, samples_batch], ignore_index = True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
243
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
244 write_to_file(samplesTotal.T, model_name, True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
245
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
246 for i in range(0, n_batches):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
247 os.remove(ARGS.output_path + "/" + model_name + '_'+ str(i)+'_CBS.csv')
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
248
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
249
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
250
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
251 def model_sampler_with_bounds(model_input_original: cobra.Model, bounds_path: str, cell_name: str) -> List[pd.DataFrame]:
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
252 """
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
253 MODE 1: Prepares the model with bounds from separate bounds file and performs sampling.
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
254
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
255 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
256 model_input_original (cobra.Model): The original COBRA model.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
257 bounds_path (str): Path to the CSV file containing the bounds dataset.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
258 cell_name (str): Name of the cell, used to generate filenames for output.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
259
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
260 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
261 List[pd.DataFrame]: A list of DataFrames containing statistics and analysis results.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
262 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
263
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
264 model_input = model_input_original.copy()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
265 bounds_df = read_dataset(bounds_path, "bounds dataset")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
266
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
267 # Apply bounds to model
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
268 for rxn_index, row in bounds_df.iterrows():
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
269 try:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
270 model_input.reactions.get_by_id(rxn_index).lower_bound = row.lower_bound
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
271 model_input.reactions.get_by_id(rxn_index).upper_bound = row.upper_bound
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
272 except KeyError:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
273 warning(f"Warning: Reaction {rxn_index} not found in model. Skipping.")
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
274
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
275 return perform_sampling_and_analysis(model_input, cell_name)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
276
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
277
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
278 def perform_sampling_and_analysis(model_input: cobra.Model, cell_name: str) -> List[pd.DataFrame]:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
279 """
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
280 Common function to perform sampling and analysis on a prepared model.
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
281
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
282 Args:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
283 model_input (cobra.Model): The prepared COBRA model with bounds applied.
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
284 cell_name (str): Name of the cell, used to generate filenames for output.
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
285
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
286 Returns:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
287 List[pd.DataFrame]: A list of DataFrames containing statistics and analysis results.
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
288 """
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
289
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
290 if ARGS.algorithm == 'OPTGP':
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
291 OPTGP_sampler(model_input, cell_name, ARGS.n_samples, ARGS.thinning, ARGS.n_batches, ARGS.seed)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
292 elif ARGS.algorithm == 'CBS':
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
293 CBS_sampler(model_input, cell_name, ARGS.n_samples, ARGS.n_batches, ARGS.seed)
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
294
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
295 df_mean, df_median, df_quantiles = fluxes_statistics(cell_name, ARGS.output_types)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
296
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
297 if("fluxes" not in ARGS.output_types):
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
298 os.remove(ARGS.output_path + "/" + cell_name + '.csv')
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
299
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
300 returnList = [df_mean, df_median, df_quantiles]
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
301
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
302 df_pFBA, df_FVA, df_sensitivity = fluxes_analysis(model_input, cell_name, ARGS.output_type_analysis)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
303
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
304 if("pFBA" in ARGS.output_type_analysis):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
305 returnList.append(df_pFBA)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
306 if("FVA" in ARGS.output_type_analysis):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
307 returnList.append(df_FVA)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
308 if("sensitivity" in ARGS.output_type_analysis):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
309 returnList.append(df_sensitivity)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
310
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
311 return returnList
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
312
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
313 def fluxes_statistics(model_name: str, output_types:List)-> List[pd.DataFrame]:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
314 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
315 Computes statistics (mean, median, quantiles) for the fluxes.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
316
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
317 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
318 model_name (str): Name of the model, used in filename for input.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
319 output_types (List[str]): Types of statistics to compute (mean, median, quantiles).
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
320
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
321 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
322 List[pd.DataFrame]: List of DataFrames containing mean, median, and quantiles statistics.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
323 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
324
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
325 df_mean = pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
326 df_median= pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
327 df_quantiles= pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
328
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
329 df_samples = pd.read_csv(ARGS.output_path + "/" + model_name + '.csv', sep = '\t', index_col = 0).T
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
330 df_samples = df_samples.round(8)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
331
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
332 for output_type in output_types:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
333 if(output_type == "mean"):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
334 df_mean = df_samples.mean()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
335 df_mean = df_mean.to_frame().T
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
336 df_mean = df_mean.reset_index(drop=True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
337 df_mean.index = [model_name]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
338 elif(output_type == "median"):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
339 df_median = df_samples.median()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
340 df_median = df_median.to_frame().T
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
341 df_median = df_median.reset_index(drop=True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
342 df_median.index = [model_name]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
343 elif(output_type == "quantiles"):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
344 newRow = []
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
345 cols = []
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
346 for rxn in df_samples.columns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
347 quantiles = df_samples[rxn].quantile([0.25, 0.50, 0.75])
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
348 newRow.append(quantiles[0.25])
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
349 cols.append(rxn + "_q1")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
350 newRow.append(quantiles[0.5])
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
351 cols.append(rxn + "_q2")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
352 newRow.append(quantiles[0.75])
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
353 cols.append(rxn + "_q3")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
354 df_quantiles = pd.DataFrame(columns=cols)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
355 df_quantiles.loc[0] = newRow
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
356 df_quantiles = df_quantiles.reset_index(drop=True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
357 df_quantiles.index = [model_name]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
358
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
359 return df_mean, df_median, df_quantiles
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
360
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
361 def fluxes_analysis(model:cobra.Model, model_name:str, output_types:List)-> List[pd.DataFrame]:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
362 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
363 Performs flux analysis including pFBA, FVA, and sensitivity analysis.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
364
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
365 Args:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
366 model (cobra.Model): The COBRA model to analyze.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
367 model_name (str): Name of the model, used in filenames for output.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
368 output_types (List[str]): Types of analysis to perform (pFBA, FVA, sensitivity).
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
369
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
370 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
371 List[pd.DataFrame]: List of DataFrames containing pFBA, FVA, and sensitivity analysis results.
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
372 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
373
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
374 df_pFBA = pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
375 df_FVA= pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
376 df_sensitivity= pd.DataFrame()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
377
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
378 for output_type in output_types:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
379 if(output_type == "pFBA"):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
380 model.objective = "Biomass"
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
381 solution = cobra.flux_analysis.pfba(model)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
382 fluxes = solution.fluxes
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
383 df_pFBA.loc[0,[rxn.id for rxn in model.reactions]] = fluxes.tolist()
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
384 df_pFBA = df_pFBA.reset_index(drop=True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
385 df_pFBA.index = [model_name]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
386 df_pFBA = df_pFBA.astype(float).round(6)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
387 elif(output_type == "FVA"):
430
f49c951c9fe6 Uploaded
francesco_lapi
parents: 422
diff changeset
388 fva = cobra.flux_analysis.flux_variability_analysis(model, fraction_of_optimum=ARGS.perc_opt, processes=1).round(8)
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
389 columns = []
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
390 for rxn in fva.index.to_list():
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
391 columns.append(rxn + "_min")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
392 columns.append(rxn + "_max")
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
393 df_FVA= pd.DataFrame(columns = columns)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
394 for index_rxn, row in fva.iterrows():
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
395 df_FVA.loc[0, index_rxn+ "_min"] = fva.loc[index_rxn, "minimum"]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
396 df_FVA.loc[0, index_rxn+ "_max"] = fva.loc[index_rxn, "maximum"]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
397 df_FVA = df_FVA.reset_index(drop=True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
398 df_FVA.index = [model_name]
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
399 df_FVA = df_FVA.astype(float).round(6)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
400 elif(output_type == "sensitivity"):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
401 model.objective = "Biomass"
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
402 solution_original = model.optimize().objective_value
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
403 reactions = model.reactions
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
404 single = cobra.flux_analysis.single_reaction_deletion(model)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
405 newRow = []
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
406 df_sensitivity = pd.DataFrame(columns = [rxn.id for rxn in reactions], index = [model_name])
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
407 for rxn in reactions:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
408 newRow.append(single.knockout[rxn.id].growth.values[0]/solution_original)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
409 df_sensitivity.loc[model_name] = newRow
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
410 df_sensitivity = df_sensitivity.astype(float).round(6)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
411 return df_pFBA, df_FVA, df_sensitivity
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
412
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
413 ############################# main ###########################################
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
414 def main(args :List[str] = None) -> None:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
415 """
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
416 Initialize and run sampling/analysis based on the frontend input arguments.
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
417
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
418 Returns:
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
419 None
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
420 """
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
421
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
422 num_processors = max(1, cpu_count() - 1)
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
423
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
424 global ARGS
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
425 ARGS = process_args(args)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
426
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
427 if not os.path.exists(ARGS.output_path):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
428 os.makedirs(ARGS.output_path)
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
429
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
430 # --- Normalize inputs (the tool may pass comma-separated --input and either --name or --names) ---
421
f9fe44c65772 Uploaded
francesco_lapi
parents: 419
diff changeset
431 ARGS.input_files = ARGS.input.split(",") if ARGS.input else []
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
432 ARGS.file_names = ARGS.name.split(",")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
433 # output types (required) -> list
421
f9fe44c65772 Uploaded
francesco_lapi
parents: 419
diff changeset
434 ARGS.output_types = ARGS.output_type.split(",") if ARGS.output_type else []
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
435 # optional analysis output types -> list or empty
421
f9fe44c65772 Uploaded
francesco_lapi
parents: 419
diff changeset
436 ARGS.output_type_analysis = ARGS.output_type_analysis.split(",") if ARGS.output_type_analysis else []
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
437
421
f9fe44c65772 Uploaded
francesco_lapi
parents: 419
diff changeset
438 print("=== INPUT FILES ===")
422
27c5a67f1ee6 Uploaded
francesco_lapi
parents: 421
diff changeset
439 print(f"{ARGS.input_files}")
27c5a67f1ee6 Uploaded
francesco_lapi
parents: 421
diff changeset
440 print(f"{ARGS.file_names}")
27c5a67f1ee6 Uploaded
francesco_lapi
parents: 421
diff changeset
441 print(f"{ARGS.output_type}")
27c5a67f1ee6 Uploaded
francesco_lapi
parents: 421
diff changeset
442 print(f"{ARGS.output_types}")
27c5a67f1ee6 Uploaded
francesco_lapi
parents: 421
diff changeset
443 print(f"{ARGS.output_type_analysis}")
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
444
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
445 if ARGS.model_and_bounds == "True":
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
446 # MODE 1: Model + bounds (separate files)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
447 print("=== MODE 1: Model + Bounds (separate files) ===")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
448
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
449 # Load base model
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
450 if not ARGS.model_upload:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
451 sys.exit("Error: model_upload is required for Mode 1")
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
452
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
453 base_model = model_utils.build_cobra_model_from_csv(ARGS.model_upload)
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
454
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
455 validation = model_utils.validate_model(base_model)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
456
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
457 print("\n=== MODEL VALIDATION ===")
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
458 for key, value in validation.items():
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
459 print(f"{key}: {value}")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
460
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
461 # Set solver verbosity to 1 to see warning and error messages only.
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
462 base_model.solver.configuration.verbosity = 1
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
463
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
464 # Process each bounds file with the base model
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
465 results = Parallel(n_jobs=num_processors)(
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
466 delayed(model_sampler_with_bounds)(base_model, bounds_file, cell_name)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
467 for bounds_file, cell_name in zip(ARGS.input_files, ARGS.file_names)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
468 )
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
469
419
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
470 else:
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
471 # MODE 2: Multiple complete models
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
472 print("=== MODE 2: Multiple complete models ===")
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
473
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
474 # Process each complete model file
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
475 results = Parallel(n_jobs=num_processors)(
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
476 delayed(perform_sampling_and_analysis)(model_utils.build_cobra_model_from_csv(model_file), cell_name)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
477 for model_file, cell_name in zip(ARGS.input_files, ARGS.file_names)
ed2c1f9e20ba Uploaded
francesco_lapi
parents: 411
diff changeset
478 )
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
479
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
480
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
481 all_mean = pd.concat([result[0] for result in results], ignore_index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
482 all_median = pd.concat([result[1] for result in results], ignore_index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
483 all_quantiles = pd.concat([result[2] for result in results], ignore_index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
484
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
485 if("mean" in ARGS.output_types):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
486 all_mean = all_mean.fillna(0.0)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
487 all_mean = all_mean.sort_index()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
488 write_to_file(all_mean.T, "mean", True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
489
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
490 if("median" in ARGS.output_types):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
491 all_median = all_median.fillna(0.0)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
492 all_median = all_median.sort_index()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
493 write_to_file(all_median.T, "median", True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
494
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
495 if("quantiles" in ARGS.output_types):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
496 all_quantiles = all_quantiles.fillna(0.0)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
497 all_quantiles = all_quantiles.sort_index()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
498 write_to_file(all_quantiles.T, "quantiles", True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
499
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
500 index_result = 3
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
501 if("pFBA" in ARGS.output_type_analysis):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
502 all_pFBA = pd.concat([result[index_result] for result in results], ignore_index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
503 all_pFBA = all_pFBA.sort_index()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
504 write_to_file(all_pFBA.T, "pFBA", True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
505 index_result+=1
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
506 if("FVA" in ARGS.output_type_analysis):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
507 all_FVA= pd.concat([result[index_result] for result in results], ignore_index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
508 all_FVA = all_FVA.sort_index()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
509 write_to_file(all_FVA.T, "FVA", True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
510 index_result+=1
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
511 if("sensitivity" in ARGS.output_type_analysis):
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
512 all_sensitivity = pd.concat([result[index_result] for result in results], ignore_index=False)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
513 all_sensitivity = all_sensitivity.sort_index()
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
514 write_to_file(all_sensitivity.T, "sensitivity", True)
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
515
456
a6e45049c1b9 Uploaded
francesco_lapi
parents: 430
diff changeset
516 return
410
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
517
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
518 ##############################################################################
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
519 if __name__ == "__main__":
d660c5b03c14 Uploaded
francesco_lapi
parents:
diff changeset
520 main()