annotate COBRAxy/fromCSVtoCOBRA_beta.py @ 456:a6e45049c1b9 draft

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