Main¶
KoswatHandler
¶
Handler for CLI usage of Koswat
. It allows the initialization of a logger during the analysis.
__init__(log_output: Optional[str]) -> None
¶
Initializes the handler creating a log file at the optional provided directory log_output
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
log_output |
Optional[str]
|
Directory where to save the |
required |
run_analysis(analysis_file: str) -> None
¶
Runs a Koswat analysis using the provided *.ini
file analysis_file
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
analysis_file |
str
|
Location of the main koswat analysis ini file. |
required |
run_analysis(input_file: str, log_output: str)
¶
CLI call to execute a Koswat analysis given a settings files (input_file
). The log is generated by default in the execute path, unless otherwise specified in the log_output
argument.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_file |
str
|
Location of the |
required |
log_output |
str
|
Optional argument to specify where will be created the |
required |