-
Notifications
You must be signed in to change notification settings - Fork 1
3. Tutorial (Advanced Settings)
Amirsadra Mohseni edited this page Jun 16, 2025
·
30 revisions
SIRIUS flags continued.
-
--soft_rscu_thresh=floating point value > 0.0- Specify if you would like to provide a soft cut-off for codons with an RSCU value under this threshold. Codons with an RSCU below this value might be excluded from the output genes. See the mathematical explanation below on how this flag behaves. Using this flag requires you to also specify the following:
-
--codon_usage_fpath=string value [No default – This is required]- Path to the .csv file containing amino acid codes, their codons, and the respective RSCU values. See TODO for an example file.
-
--max_low_rscu_ratio=floating point value between 0-1 [Defaults to 0.3 if unspecified]- TODO
-
--rscu_alpha=floating point value > 0 [Defaults to 10.0 if unspecified]- TODO
-
- Specify if you would like to provide a soft cut-off for codons with an RSCU value under this threshold. Codons with an RSCU below this value might be excluded from the output genes. See the mathematical explanation below on how this flag behaves. Using this flag requires you to also specify the following:
-
--num_workers=integer value > 0 [Defaults to 16 if unspecified]- Specify the number of threads available to the Google OR-Tools solver. A value between 16-32 is ideal. Higher values may actually slow the solve.
-
--show_ortools_log=boolean value (true/false) [Defaults to false if unspecified]- When
true, outputs the Google OR-Tools logs.
- When
-
--relative_gap_limit=floating point value between 0-1 [Defaults to 0.0 if unspecified]- A larger value tells the solver to accept a sub-optimal solution. Only increase this (and slightly, perhaps starting with 0.1, which is 10%) if you are experiencing high solve times.
The third way to run SIRIUS is via the config.yaml file. Note that any flags passed to SIRIUS will cause the program to ignore all settings in the config.yaml, and instead only use those flags.
TODO
TODO