annotate COBRAxy/flux_simulation_beta.py @ 475:c91c502f12e9 draft

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