viktor.external.grlweap

GRLWeapAnalysis

class viktor.external.grlweap.GRLWeapAnalysis(input_file)¶

Bases: ExternalProgram

GRLWeapAnalysis can be used to perform an analysis using GRLWeap on a third-party worker. To start an analysis call the method execute(), with an appropriate timeout (in seconds). To retrieve the results call the method get_output_file(), after execute().

Usage:

grlweap_analysis = GRLWeapAnalysis(input_file=gwt_file)
grlweap_analysis.execute(timeout=10)
result = grlweap_analysis.get_output_file()

Exceptions which can be raised during calculation: - viktor.errors.ExecutionError: generic error. Error message provides more information

Parameters

input_file (Union[BytesIO, File]) – .gwt input file.

get_output_file(*, as_file=False)¶

Method can be used to retrieve the results generated by running an external analysis. Call method execute() first and get_output_file() afterwards.

Parameters

as_file (bool) – Return as BytesIO (default) or File

New in v13.5.0

Return type

Union[BytesIO, File, None]