annotate COBRAxy/tabular2MetabolicModel.py @ 491:7a413a5ec566 draft

Uploaded
author francesco_lapi
date Mon, 29 Sep 2025 15:34:59 +0000
parents
children df90f40a156c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
491
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
1 """
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
2 Convert a tabular (CSV/TSV/Tabular) description of a COBRA model into a COBRA file.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
3
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
4 Supported output formats: SBML, JSON, MATLAB (.mat), YAML.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
5 The script logs to a user-provided file for easier debugging in Galaxy.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
6 """
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
7
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
8 import os
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
9 import cobra
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
10 import argparse
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
11 from typing import List
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
12 import logging
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
13 import utils.model_utils as modelUtils
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
14
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
15 ARGS : argparse.Namespace
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
16 def process_args(args: List[str] = None) -> argparse.Namespace:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
17 """
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
18 Parse command-line arguments for the CSV-to-COBRA conversion tool.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
19
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
20 Returns:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
21 argparse.Namespace: Parsed arguments.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
22 """
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
23 parser = argparse.ArgumentParser(
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
24 usage="%(prog)s [options]",
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
25 description="Convert a tabular/CSV file to a COBRA model"
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
26 )
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
27
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
28
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
29 parser.add_argument("--out_log", type=str, required=True,
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
30 help="Output log file")
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
31
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
32
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
33 parser.add_argument("--input", type=str, required=True,
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
34 help="Input tabular file (CSV/TSV)")
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
35
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
36
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
37 parser.add_argument("--format", type=str, required=True, choices=["sbml", "json", "mat", "yaml"],
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
38 help="Model format (SBML, JSON, MATLAB, YAML)")
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
39
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
40
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
41 parser.add_argument("--output", type=str, required=True,
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
42 help="Output model file path")
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
43
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
44
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
45 parser.add_argument("--tool_dir", type=str, default=os.path.dirname(__file__),
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
46 help="Tool directory (passed from Galaxy as $__tool_directory__)")
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
47
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
48
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
49 return parser.parse_args(args)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
50
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
51
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
52 ###############################- ENTRY POINT -################################
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
53
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
54 def main(args: List[str] = None) -> None:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
55 """
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
56 Entry point: parse arguments, build the COBRA model from a CSV/TSV file,
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
57 and save it in the requested format.
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
58
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
59 Returns:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
60 None
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
61 """
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
62 global ARGS
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
63 ARGS = process_args(args)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
64
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
65 # configure logging to the requested log file (overwrite each run)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
66 logging.basicConfig(filename=ARGS.out_log,
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
67 level=logging.DEBUG,
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
68 format='%(asctime)s %(levelname)s: %(message)s',
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
69 filemode='w')
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
70
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
71 logging.info('Starting fromCSVtoCOBRA tool')
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
72 logging.debug('Args: input=%s format=%s output=%s tool_dir=%s', ARGS.input, ARGS.format, ARGS.output, ARGS.tool_dir)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
73
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
74 try:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
75 # Basic sanity checks
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
76 if not os.path.exists(ARGS.input):
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
77 logging.error('Input file not found: %s', ARGS.input)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
78
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
79 out_dir = os.path.dirname(os.path.abspath(ARGS.output))
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
80
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
81 if out_dir and not os.path.isdir(out_dir):
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
82 try:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
83 os.makedirs(out_dir, exist_ok=True)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
84 logging.info('Created missing output directory: %s', out_dir)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
85 except Exception as e:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
86 logging.exception('Cannot create output directory: %s', out_dir)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
87
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
88 model = modelUtils.build_cobra_model_from_csv(ARGS.input)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
89
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
90 # Save model in requested format
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
91 if ARGS.format == "sbml":
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
92 cobra.io.write_sbml_model(model, ARGS.output)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
93 elif ARGS.format == "json":
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
94 cobra.io.save_json_model(model, ARGS.output)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
95 elif ARGS.format == "mat":
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
96 cobra.io.save_matlab_model(model, ARGS.output)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
97 elif ARGS.format == "yaml":
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
98 cobra.io.save_yaml_model(model, ARGS.output)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
99 else:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
100 logging.error('Unknown format requested: %s', ARGS.format)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
101 print(f"ERROR: Unknown format: {ARGS.format}")
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
102
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
103
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
104 logging.info('Model successfully written to %s (format=%s)', ARGS.output, ARGS.format)
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
105
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
106 except Exception:
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
107 # Log full traceback to the out_log so Galaxy users/admins can see what happened
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
108 logging.exception('Unhandled exception in fromCSVtoCOBRA')
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
109
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
110
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
111 if __name__ == '__main__':
7a413a5ec566 Uploaded
francesco_lapi
parents:
diff changeset
112 main()