annotate COBRAxy/fromCSVtoCOBRA.py @ 489:97eea560a10f draft

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